void-linux / void-linux/void-docs
Tracking: wiki content still to be added to the Handbook
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 217
- Forks
- 212
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 1
Description
i've now completed a low-hanging-fruit pass of wiki articles to mark articles that i'm confident are either:
- satisfactorily covered by the Handbook; and/or
- clearly out-of-scope for the Handbook (e.g. don't contain any Void-specific information beyond something like
xbps-install <package>).
i've marked such articles by renaming them to include a trailing dash, to make them visible on the AllPages wiki page. In the cases where there's a Handbook section directly corresponding to a wiki article - which is not always the case - i've removed the article contents and replaced it with the text "As this wiki is deprecated, and will soon disappear, please refer to <link to Handbook section>."
i have intentionally not provided redirects from the old page name to the new page name, so that search engines reduce the ranking of the wiki in search results. (A Google search for 'void pulseaudio' currently ranks the wiki above the Handbook.)
The following is a list of all articles not so marked by this process:
- Acpi - #342 (merged)
- Adb - out-of-scope, unneeded
- Android - out-of-scope, unneeded
- AppArmor - covered by "AppArmor" section
- AppImages - mention in "External Applications" section? #469 (merged)
- Arduino - out-of-scope, unneeded
- Automatic Login to Graphical Environment - out-of-scope? unneeded?
- Automount - out-of-scope, unneeded
- Autox - out-of-scope, unneeded
- Beaglebone - comment
- Bspwm - out-of-scope? unneeded? definitely
- Cinnamon - out-of-scope
- Compiz
- Console mouse support - out-of-scope? unneeded?
- Create Git Versions of Packages - out-of-scope
- Cross Compiler - include in void-packages/README.md?
- Cubieboard2 NAND Install Hack - comment
- Cubieboard2 SD-Card - comment
- Cubox - comment
- Cuda - #363
- Disks - sufficiently covered by "Partitioning Notes"?
- Distcc - out-of-scope, unneeded
- Dmix - #335 (merged)
- Docker - #151, #350
- Dolphin - add to "KDE" section? #436 (merged)
- Dynamic Kernel Module Support - add under DKMS heading in "Kernel" section? #476 (merged)
- Embedded Images - comment
- FAQ - 'redirect' page, unneeded
- Firewall Configuration - #266 (closed): #352 (merged), #356 (merged)
- Firewall Guide - #266 (closed): #352 (merged), #356 (merged)
- Frequently Asked Questions - #337 (closed)
- Full Disk Encryption w/Encrypted Boot - #284
- Guides - 'ToC' page, unneeded
- Hashboot - covered by "Hashboot" section (comment)
- Hexchat - out-of-scope, unneeded; possible packaging issue?
- Infrastructure - how much is still current? If wanted, more suitable for InfraDocs? If we want to cover any of this, open issue in void-infrastructure
- Install LVM LUKS
- Install LVM LUKS on UEFI GPT
- Install Void Linux onto a USB Stick - #177 (merged)
- Install alongside Arch Linux - out-of-scope, unneeded
- Install android
- Install on a VPS - out-of-scope, unneeded
- Installation - sufficiently covered by "Installation" section?
- Installation: UEFI - sufficiently covered by "Installation" section?
- Installation On UEFI With MDRAID, via chroot
- Installation on UEFI, via chroot - #177 (merged)
- Installation via chroot - #177 (merged)
- Installer Partitioning - sufficiently covered by "Partitioning Notes" section?
- Installing alongside Arch Linux - out-of-scope, unneeded
- Known Issues
- Libc - 'ToC' page, unneeded
- Libinput - out-of-scope?
- Little Helpers - obsolete, unneeded
- "Locked out - using various system recovery options to reset the password" - out-of-scope, unneeded
- Locking the root account and using sudo - out-of-scope, unneeded
- Lutris - out-of-scope, unneeded
- Lyx: the document processor - out-of-scope (comment)
- MP4 / h.264 in Firefox - out-of-scope, unneeded
- Macbook - #110
- Main Page - 'ToC' page, unneeded
- Main Page/es - 'ToC' page, unneeded
- Man page - covered by "About this Handbook", unneeded
- Manual Install with encrypted boot
- Manual install w/full disk encryption - #284
- Manual install w/full disk encryption (on MBR) - #284
- Manual install with ZFS root - #206
- Manual pages - 'redirect' page, unneeded
- Mc - 'redirect' page, unneeded
- Midnight Commander - out-of-scope, unneeded; possible upstream documentation issue?
- Mounting filesystems as a user with udevil - out-of-scope, unneeded; possible packaging/upstream issue?
- Network filesystem - include in a "Network filesystems" section? (Partial: #399, merged, for NFS)
- Pinebook Pro
- Post Installation - sufficiently covered by existing sections?
- Raspberry Pi - #402 (merged)
- Raspberry Pi (External HDD with LUKS + Berryboot)
- Rfkill - #336 (merged)
- Rootfs Images - 'redirect' page, unneeded
- Rosetta stone - #111 (closed)
- SANE - include in "Printing" section, as "Printing and Scanning" section?
- SaltStack for Void Linux
- Samba - comment
- Steam - #159
- USB Armory - comment
- VirtualBox - #350
- Void mklive - covered by "Image Building" in InfraDocs
- Xfce - comment, comment
- Xmonad - out-of-scope? unneeded? out of scope and unnecessary
This list looks more substantial than it probably actually is: i've very much erred on the side of caution during the marking process (hence my reference to a "low-hanging-fruit pass"). Thus, for example:
- the "Rfkill" article is probably not needed; we could instead briefly mention it in e.g. config/network/index.md (it's already mentioned in bluetooth.md);
- the "Post Installation" article is probably adequately covered by various sections in the Handbook, but this needs to be confirmed;
- the "Dmix" article might only require a mention of dmix in the "ALSA" section;
and so on.
i'm now opening this issue to provide a single location for tracking what still needs to be done before we can decommission the wiki, and so that members of the Void team can help out with a second pass. As people provide their thoughts about the articles in the above list, i'll add text next to each item to reflect its status.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the unchecked articles in this tracking issue and compare each one with the corresponding Handbook sections or linked issues. Review the referenced comments and existing Handbook coverage before deciding whether an article is needed. Done means every remaining item has a documented disposition and the wiki content is covered, out of scope, or tracked elsewhere.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100