From 6a9f11a95a1f53f74d06082de1240580737ba894 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Mon, 24 Apr 2023 04:38:23 +0100 Subject: [PATCH] link docs/maintain/ from home pages we want to attract developers --- site/docs/maintain/porting.md | 5 ++++- site/docs/maintain/testing.md | 20 +++++++++++++++----- site/index.fr.md | 11 +++++++++++ site/index.md | 11 +++++++++++ site/index.uk.md | 11 +++++++++++ 5 files changed, 52 insertions(+), 6 deletions(-) diff --git a/site/docs/maintain/porting.md b/site/docs/maintain/porting.md index 3a98186..2eb1ecb 100644 --- a/site/docs/maintain/porting.md +++ b/site/docs/maintain/porting.md @@ -1,7 +1,10 @@ --- -title: Porting Guide +title: Porting guide for new mainboards ... +NOTE: This page is largely Intel-centric, at present. It should be revised to +cover more vendors. [Patches welcome!](../../git.md) + This guide is intended for those with very little knowledge of firmware in general and coreboot in particular. Most boards in coreboot can be quite easily ported to libreboot. diff --git a/site/docs/maintain/testing.md b/site/docs/maintain/testing.md index 37571b0..45bff01 100644 --- a/site/docs/maintain/testing.md +++ b/site/docs/maintain/testing.md @@ -1,8 +1,13 @@ --- -title: Board Maintainers Guide +title: Apply to become board maintainer/tester for Libreboot x-toc-enable: true ... +This page is very new, and these guidelines/procedures will be revised over +time. We are, as of April 2023, formalising our testing / release engineering +procedures somewhat. The Libreboot project is *expanding* to support a lot +more hardware these days. + Libreboot strives to make Coreboot accessible for as many users as possible. To accomplish this goal, we must add as many boards as possible. As the total number of supported boards increases it becomes more and more difficult @@ -18,18 +23,23 @@ All you need to do in order to become a board maintainer is: + Have the board you wish to maintain Once you become a board maintainer, your real name and screen name can -be added to the public list on [libreboot.org.](/index.html) -You can, of course, choose to forego the public listing. +be added to the public list on the Libreboot contributors page. +You can, of course, choose to forego the public listing (we will ask for +permission, before publishing your name). -To apply as a board maintainer, ping `leah` or `shmalebx9` on +To apply for such a posting, ping `leah` or `shmalebx9` on [irc,](../../contact.html#irc-chatroom) or email -Caleb at [thonkpeasant@protonmail.com](mailto:thonkpeasant@protonmail.com) +Leah Rowe via [leah@libreboot.org](mailto:leah@libreboot.org) Do not be afraid to apply to maintain a board with another listed maintainer or multiple maintainers; more is better. Please read the following sections to understand the specifics of maintaining a board. +NOTE: If there are already testers for a given mainboard, *you* can still +provide testing for the same mainboard if that's what you have. The more the +merrier! + Be Contactable ============== diff --git a/site/index.fr.md b/site/index.fr.md index b1b6103..51c7d7b 100644 --- a/site/index.fr.md +++ b/site/index.fr.md @@ -75,6 +75,17 @@ pouvez les installez simplement, sans connaissance ou compétence particulière Comment aider ----------- +The *single* biggest way you can help it to *add* new mainboards to Libreboot, +by submitting a config. Anything coreboot supports can be integrated in +Libreboot, with ROM images provided in releases. See: + +* [Apply to become a board maintainer/tester](docs/maintain/testing.md) +* [Porting guide for new mainboards](docs/maintain/porting.md) +* [Libreboot build system documentation](docs/maintain/) + +After that, there is build system maintenance (see above), and *documentation* +which we take seriously. Documentation is critical, in any project. + Vous pouvez allez voir les bugs listés sur le [traqueur de bugs](https://codeberg.org/libreboot/lbmk/issues). Si vous trouvez un bug et avez un correctif, [voici les instructions pour envoyer des patchs](git.md), et vous pouvez aussi nous les signaler. diff --git a/site/index.md b/site/index.md index 0f12436..178336c 100644 --- a/site/index.md +++ b/site/index.md @@ -75,6 +75,17 @@ users](docs/install/). How to help ----------- +The *single* biggest way you can help it to *add* new mainboards to Libreboot, +by submitting a config. Anything coreboot supports can be integrated in +Libreboot, with ROM images provided in releases. See: + +* [Apply to become a board maintainer/tester](docs/maintain/testing.md) +* [Porting guide for new mainboards](docs/maintain/porting.md) +* [Libreboot build system documentation](docs/maintain/) + +After that, there is build system maintenance (see above), and *documentation* +which we take seriously. Documentation is critical, in any project. + You can check bugs listed on the [bug tracker](https://codeberg.org/libreboot/lbmk/issues). diff --git a/site/index.uk.md b/site/index.uk.md index 4d4c901..815bf19 100644 --- a/site/index.uk.md +++ b/site/index.uk.md @@ -69,6 +69,17 @@ Coreboot помітно складний для встановлення для Як допомогти ----------- +The *single* biggest way you can help it to *add* new mainboards to Libreboot, +by submitting a config. Anything coreboot supports can be integrated in +Libreboot, with ROM images provided in releases. See: + +* [Apply to become a board maintainer/tester](docs/maintain/testing.md) +* [Porting guide for new mainboards](docs/maintain/porting.md) +* [Libreboot build system documentation](docs/maintain/) + +After that, there is build system maintenance (see above), and *documentation* +which we take seriously. Documentation is critical, in any project. + Ви можете перевірити помилки, перелічені в [системі відстеження помилок](https://codeberg.org/libreboot/lbmk/issues).