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) |
| Bugs | Related bugs |
| 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 previous '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.
Trusted community contributors
Starting in 2024, the Handbook project will, at its discretion, allow certain community members to fill the role of handbook editor. These individuals have made positive impact and helpful contributions around the wiki at large or particularly via discussions on handbook pages. They must be approachable in the wiki's IRC channel (#gentoo-wiki (webchat)) to discuss changes from the wiki project community or developers and continue to make contributions to maintain this role.
Due to the handbook being Gentoo's premier document, the Handbook project may remove handbook editor privilege any time. This may include accounts which reach an timeout due to inactivity.
| Name | Role | Start date | End date | Notes |
|---|---|---|---|---|
| Brian Evans (Grknight) | Handbook editor | 2024-01-11 | TBD | Former dev and trusted contributor. Always makes things better. |
| needle (Needle) | Handbook editor | 2024-01-11 | TBD | Community member |
| Christopher Fore (Xarvatium) | Handbook editor | 2024-01-05 | TBD | Community member |
| Zen (Zen desu) | Handbook editor | 2024-01-05 | TBD | Community member |
Goals
The goals of this project are listed below.
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 handbook discussions.
2024
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.
Fix/update the disk partitioning sections of the amd64 and x86 Handbooks. Cover:- 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.
- 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.Added by Zen (zen_desu) here: Special:Diff/1273365/1273604.- Add systemd-networkd instructions for basic DHCP and static IP addressing.
- Add a section on system timer management.
- Adjust Portage binary host section here: Handbook:Parts/Working/Features#Binary_package_support
Resources
- Gentoo Handbook development - Information for Handbook maintainers and translators regarding Gentoo handbook development.