Project:Handbook
| Handbook | |
|---|---|
| Description | The Handbook project is responsible for maintaining Gentoo's official Handbook. |
| Project email | handbook@gentoo.org |
| IRC channel | #gentoo-wiki (webchat) |
| Lead(s) | none Last elected: 2022-07-18 |
| Member(s) |
|
| Subproject(s) (and inherited member(s)) |
(none) |
| Parent Project | Wiki |
| Project listing | |
After many essential and necessary years of service the Gentoo Documentation Project (GDP) has fulfilled its purpose.[1][2]
As a platform, the wiki has enabled every Gentoo developer (not just those in the Documentation team) and many in the community to maintain Gentoo documentation. Most of the articles produced by the former documentation team are in publicly editable namespaces.
In order to clarify who will continue to assume responsibility for the Gentoo Handbook, the Handbook project was created as a sub-project of the Wiki project. The Handbook contains Gentoo's official and crucial installation instructions, since it is risky to put official installation documentation into publicly editable namespaces.
Suggestions for Handbook improvements can be left on each section's related discussion page. Among other areas of contribution, members of the Handbook project will make it a priority to respond to these critiques.
The goals of this project are listed below.
Goals
Long term / Recurring
These goals will be with us each year:
- Handle 'marking' updated sections of the Handbook for translation.
- Maintain the Handbook Development guide.
- Look after open discussions in the Handbook namespace.
2023
Applied changes to handbooks can now be discovered at Handbook:Main Page/Changelog. Rationale and instructions for maintaining the changelog are detailed here.
Changes that are intended, but not yet implemented in the handbooks are in the change backlog.
Change backlog
- Close open discussions in Handbook namespace.
- Modernize and maintain the official Gentoo Handbook documentation in the Handbook: namespace. This task is a bit subjective, but we need to fully cover UEFI installs,
NVME/M.2 devices(done!). - Fix/update the disk partitioning sections of the amd64 and x86 Handbooks. Cover:
- MBR
- GPT with BIOS boot partition (Legacy mobo's will support GPT). Resources: 1, 2, 3
- GPT with EFI
- Close this discussion: Property_talk:Efi-system-partition#.2Fdev.2Fsda1_is_wrong_at_least_for_AMD64
- Recommend moving the ESP mount point from /efi/boot to /efi.[3]
- Fix wireless network section wireless networking section. Is it even possible to use wpa_supplicant / iwd on in the official minimal and admin live images?
- Wireless does work with net-setup, however SSID names are not discoverable...
- Migrate links in the Handbook to use the new {{Link}} template so that translations can work properly.
- Mark sections with the {{Anchor}} template for persistent linking between languages.
- Terminology update: Live CD, Live DVD to "live image". See bug #903551.
- Add instructions for creating USB-based live image from Linux. See bug #902813.
- Add systemd-networkd instructions for basic DHCP and static IP addressing.
- Add a section on system timer management.
- Align GPT/EFI installation disk partitions to UAPI Group Specification's Discoverable Partitions Specification. See parts under: Handbook:Parts/Installation/System. New SMW properties will be needed so that they can be set on each ARCH Handbook landing page. Also closes this discussion.
- Migrate ESP to /efi as recommended per UAPI Group Specification's Boot Loader Specification Mount Point section. This will help avoid unnecessary complication that has historically arisen between the filesystem of /boot and sub-mount point of /boot/efi being a different filesystem, as well as better align with a standardization attempt.
Resources
- Gentoo Handbook development - Information for Handbook maintainers and translators regarding Gentoo handbook development.