GNUBoot/gnuboot
GNUBoot
/
gnuboot
mirror of https://git.savannah.gnu.org/git/gnuboot.git
2
1
Fork 0
Code Issues Releases Activity
gnuboot/website/pages/docs/index.md

51 lines
1.5 KiB
Markdown
Raw Normal View History

libreboot site new one
2021-05-18 14:21:48 +02:00
---
title: Documentation
...
Add a minimal GNU Boot manual. Currently GNU Boot has no manual, and it needs one to organize better the information it provides to users and/or contributors. Since we need to start somewhere, beside adding the manual license, we describe a bit what the GNU Boot project is, and also ask for help for completing the manual. The GFDL 1.3 comes from the gnulib source code at the commit d64d66cc4897d605f543257dcd038524a0a55215 ("autoupdate"). The beginning and the end of the document are also very similar to the GNU Hello manual from the commit 24225d705684322f482135e8a2d679485fce0811 ("maint: remove the obsolete gettext module") as they were copied and modified from that. The 'dircategory Kernel' was chosen to be the same than GRUB, so they both appear in the same group in the Emacs info reader ('info' command in Emacs). As for the "Overview" of GNU Boot it also contains background information that will be needed later on and that needs to be introduced right from the start: - If people reading the manual do not understand what a boot software is, all the rest will be too complicated to explain. - We also need to explain where GNU Boot is physically located on the computer from the start as we plan not to use the 'ROM' terminology as it's confusing: ROM means read-only-memory, and so there is no point of providing GNU Boot ROM images if the nonfree boot software can't be replaced. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien Bourmault <neox@gnu.org>
2024-11-24 18:10:47 +01:00
Manuals
=======
The GNU Boot project started creating a manual
([online](../manual/gnuboot.html), [pdf](../manual/gnuboot.pdf)) to
better organize the documentation about GNU Boot. It also enables to
target a wider diversity of users, contributors and maintainers.
Note that the online manual can also be saved locally. In that case
it's a good idea to also save the
[SOIC-16.jpeg](../manual/images/SOIC-16.jpeg) picture in the same directory
to make the image(s) work.
libreboot site new one
2021-05-18 14:21:48 +02:00
website: docs: shorten part about news and put it in a section. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:35 +02:00
General information
===================
libreboot site new one
2021-05-18 14:21:48 +02:00
website: Remove news generation. We have redundant news systems: GNU Boot is already using GNU and Savannah's new infrastructure, so we don't need to duplicate that on the GNU Boot website. This lowers the maintenance now (as we need to do less work to publish news). But it also lowers the amount of work in the future as Untitled (the static website generator that we use) handles news generation differently from the rest of the pages, and since we planned to migrate to Haunt, getting rid of news generation should probably divide the amount of work needed to do the migration by two. Thanks a lot to Adrien 'neox' Bourmault for the help with this patch (neox gave me the links, told me about the capabilities of Savannah, Planet, etc). Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien Bourmault <neox@gnu.org>
2024-09-06 19:22:10 +02:00
- Information about where to find GNU Boot news, including release
announcements, can be found in the [news page](../news.md).
website: docs: shorten part about news and put it in a section. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:35 +02:00
- [Answers to Frequently Asked Questions about GNU Boot](../faq.md).
libreboot site new one
2021-05-18 14:21:48 +02:00
website: docs: index: move version information in a separate page. The information on how to find the GNU Boot version that is running is outdated (for instance there is no lbversion, it also refers to older Libreboot revisions). Because of that, we move it in a separate page for now as this can then enable to remove the unreviewed tag to the docs index page. This is urgent and important as the docs link is available in the header of most pages of the website, and also because the docs page also links to pages that were reviewed and that are perfectly valid, so readers might stop there and not look at other pages below. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:36 +02:00
Installing and updating GNU Boot
================================
libreboot site new one
2021-05-18 14:21:48 +02:00
website: docs: Installing: rename Libreboot to GNU Boot. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:32 +02:00
- [What systems can I use GNU Boot on?](hardware/)
- [How to install GNU Boot](install/)
website: docs: index: move version information in a separate page. The information on how to find the GNU Boot version that is running is outdated (for instance there is no lbversion, it also refers to older Libreboot revisions). Because of that, we move it in a separate page for now as this can then enable to remove the unreviewed tag to the docs index page. This is urgent and important as the docs link is available in the header of most pages of the website, and also because the docs page also links to pages that were reviewed and that are perfectly valid, so readers might stop there and not look at other pages below. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:36 +02:00
- [How do I know what version I'm running?](install/version.md)
libreboot site new one
2021-05-18 14:21:48 +02:00
Renamed the link in site/docs/index.md because the new name is GNU+Linux guides Also added information about Magic SysRq keys. in sites/doc/gnulinux/index.md
2021-07-15 19:58:32 +02:00
Documentation related to operating systems
website: docs: operating systems: rename Libreboot to GNU Boot. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:33 +02:00
==========================================
libreboot site new one
2021-05-18 14:21:48 +02:00
Renamed the link in site/docs/index.md because the new name is GNU+Linux guides Also added information about Magic SysRq keys. in sites/doc/gnulinux/index.md
2021-07-15 19:58:32 +02:00
- [GNU+Linux Guides](gnulinux/)
libreboot site new one
2021-05-18 14:21:48 +02:00
- [How to install BSD on a libreboot system](bsd/)
Information for developers
==========================
website: docs: operating systems: rename Libreboot to GNU Boot. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-09-06 18:15:33 +02:00
- [How to compile the GNU Boot source code](build/)
website: add history page of the GNU Boot git repositories. While this doesn't show the complete history of GNU Boot, it is at least useful for fixing missing copyrights inside copyright headers. Also I tried adding the first tarball releases of Libreboot, before it was in git, inside the same git-history.dot and it turned out to be way too messy as some arrows ended up mostly in the same place making it impossible to distinguish which arrow went where without using color or other ways of distinguishing them. However the textual version of the tarball history turned out to be easier to read/understand so we used that. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> neox: minor fix in the commit message Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
2024-08-26 14:25:27 +02:00
- [GNU Boot source code history and provenance](history/)
remove nuke notices for c201 stuff. the docs will be retained
2021-11-19 09:49:15 +01:00
- [Depthcharge payload](depthcharge/) (**Libreboot 20160907 only**)
libreboot site new one
2021-05-18 14:21:48 +02:00
- [GRUB payload](grub/)
Other information
=================
- [Miscellaneous](misc/)
website: Remove news generation. We have redundant news systems: GNU Boot is already using GNU and Savannah's new infrastructure, so we don't need to duplicate that on the GNU Boot website. This lowers the maintenance now (as we need to do less work to publish news). But it also lowers the amount of work in the future as Untitled (the static website generator that we use) handles news generation differently from the rest of the pages, and since we planned to migrate to Haunt, getting rid of news generation should probably divide the amount of work needed to do the migration by two. Thanks a lot to Adrien 'neox' Bourmault for the help with this patch (neox gave me the links, told me about the capabilities of Savannah, Planet, etc). Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org> Acked-by: Adrien Bourmault <neox@gnu.org>
2024-09-06 19:22:10 +02:00
- [List of codenames](misc/codenames.md)