void-linux
Tracking: wiki content still to be added to the Handbook
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:
- [x] Acpi - #342 (merged)
- [x] Adb - out-of-scope, unneeded
- [x] Android - out-of-scope, unneeded
- [x] AppArmor - covered by "AppArmor" section
- [x] AppImages - mention in "External Applications" section? #469 (merged)
- [x] Arduino - out-of-scope, unneeded
- [ ] Automatic Login to Graphical Environment - out-of-scope? unneeded?
- [x] Automount - out-of-scope, unneeded
- [x] Autox - out-of-scope, unneeded
- [x] Beaglebone - comment
- [x] Bspwm - out-of-scope? unneeded? definitely
- [x] Cinnamon - out-of-scope
- [ ] Compiz
- [ ] Console mouse support - out-of-scope? unneeded?
- [x] 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
- [x] Cubox - comment
- [ ] Cuda - #363
- [ ] Disks - sufficiently covered by "Partitioning Notes"?
- [x] Distcc - out-of-scope, unneeded
- [x] Dmix - #335 (merged)
- [ ] Docker - #151, #350
- [x] Dolphin - add to "KDE" section? #436 (merged)
- [x] Dynamic Kernel Module Support - add under DKMS heading in "Kernel" section? #476 (merged)
- [x] Embedded Images - comment
- [x] FAQ - 'redirect' page, unneeded
- [x] Firewall Configuration - #266 (closed): #352 (merged), #356 (merged)
- [x] Firewall Guide - #266 (closed): #352 (merged), #356 (merged)
- [x] Frequently Asked Questions - #337 (closed)
- [ ] Full Disk Encryption w/Encrypted Boot - #284
- [x] Guides - 'ToC' page, unneeded
- [x] Hashboot - covered by "Hashboot" section (comment)
- [x] Hexchat - out-of-scope, unneeded; possible packaging issue?
- [x] 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
- [x] Install Void Linux onto a USB Stick - #177 (merged)
- [x] Install alongside Arch Linux - out-of-scope, unneeded
- [ ] Install android
- [x] 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
- [x] Installation on UEFI, via chroot - #177 (merged)
- [x] Installation via chroot - #177 (merged)
- [ ] Installer Partitioning - sufficiently covered by "Partitioning Notes" section?
- [x] Installing alongside Arch Linux - out-of-scope, unneeded
- [ ] Known Issues
- [x] Libc - 'ToC' page, unneeded
- [ ] Libinput - out-of-scope?
- [x] Little Helpers - obsolete, unneeded
- [x] "Locked out - using various system recovery options to reset the password" - out-of-scope, unneeded
- [x] Locking the root account and using sudo - out-of-scope, unneeded
- [x] Lutris - out-of-scope, unneeded
- [x] Lyx: the document processor - out-of-scope (comment)
- [x] MP4 / h.264 in Firefox - out-of-scope, unneeded
- [ ] Macbook - #110
- [x] Main Page - 'ToC' page, unneeded
- [x] Main Page/es - 'ToC' page, unneeded
- [x] 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
- [x] Manual pages - 'redirect' page, unneeded
- [x] Mc - 'redirect' page, unneeded
- [x] Midnight Commander - out-of-scope, unneeded; possible upstream documentation issue?
- [x] Mounting filesystems as a user with udevil - out-of-scope, unneeded; possible packaging/upstream issue?
- [x] Network filesystem - include in a "Network filesystems" section? (Partial: #399, merged, for NFS)
- [ ] Pinebook Pro
- [ ] Post Installation - sufficiently covered by existing sections?
- [x] Raspberry Pi - #402 (merged)
- [ ] Raspberry Pi (External HDD with LUKS + Berryboot)
- [x] Rfkill - #336 (merged)
- [x] Rootfs Images - 'redirect' page, unneeded
- [x] Rosetta stone - #111 (closed)
- [ ] SANE - include in "Printing" section, as "Printing and Scanning" section?
- [ ] SaltStack for Void Linux
- [x] Samba - comment
- [ ] Steam - #159
- [ ] USB Armory - comment
- [ ] VirtualBox - #350
- [x] Void mklive - covered by "Image Building" in InfraDocs
- [x] Xfce - comment, comment
- [x] 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.
Made everything into a checkbox, so we can more easily mark what's already been dealt with. Thanks for looking into this!
@ericonr: Great, thanks. :-) We should make sure that nothing gets checked off without a short explanation beside it - i don't want people to have to read through (what will probably end up being) a long comment thread to find an explanation.
Please be careful when editing the comment containing the task list! Twice now i've done an update, only to find that GitHub has not only not included the update, it's reverted to a much earlier version. :-/ i couldn't find a way to manually revert to the penultimate revision; if only there were a VCS that allowed that. :-P
re what #177 covers:
yes
- Install Void Linux onto a USB Stick
- Installation on UEFI, via chroot - #177?
no
- Installation On UEFI With MDRAID, via chroot - #177?
i'm preparing a post for /r/voidlinux about recent work on the Handbook, and the post includes a link to this issue.
@bobertlo: Might you be able to go through the list as it currently stands, and indicate whether any of the unchecked items could be checked off?
Given that the wiki is (temporarily?) down, http://web.archive.org/web/20190228221339/https://wiki.voidlinux.org/Special:AllPages
The HTTP link works better http://web.archive.org/web/20190228221339/http://wiki.voidlinux.org/Special:AllPages
- http://web.archive.org/web/20191211213225/https://wiki.voidlinux.org/AppImages
- http://web.archive.org/web/20191211213222/https://wiki.voidlinux.org/Automatic_Login_to_Graphical_Environment - a bit out of scope, we already link to the agetty manpage where this information can be obtained; might make sense to mention explicitly
- http://web.archive.org/web/20191211212418/https://wiki.voidlinux.org/Beaglebone - not sure we need this one since it's supposedly broken right now
- http://web.archive.org/web/20191211213236/https://wiki.voidlinux.org/Bspwm - very out of scope
- http://web.archive.org/web/20190228221156/https://wiki.voidlinux.org/Cinnamon - 100% out of scope
- http://web.archive.org/web/20190228221336/https://wiki.voidlinux.org/Compiz - not sure, installing should be a matter of
xbps-query -Rs compiz - http://web.archive.org/web/20190228221510/https://wiki.voidlinux.org/Console_mouse_support - no bloody idea. I certainly had no idea such a package existed
- http://web.archive.org/web/20190228222249/https://wiki.voidlinux.org/Create_Git_Versions_of_Packages - extremely not kosher, but I guess it should be documented somewhere at some point
- http://web.archive.org/web/20191211212230/https://wiki.voidlinux.org/Cross_Compiler - not sure what exactly still needs to be included in void-packages/README.md
- http://web.archive.org/web/20190228221137/https://wiki.voidlinux.org/Cubieboard2_NAND_Install_Hack + http://web.archive.org/web/20190228221319/https://wiki.voidlinux.org/Cubieboard2_SD-Card - will use for ARM stuff
- http://web.archive.org/web/20190228221318/https://wiki.voidlinux.org/Cubox - don't think this one should be included, author could be invited to work on an official image, of course
- http://web.archive.org/web/20190228221709/https://wiki.voidlinux.org/Cuda - potentially solvable in packaging as well
- http://web.archive.org/web/20190228221205/https://wiki.voidlinux.org/Disks + http://web.archive.org/web/20190228221355/https://wiki.voidlinux.org/Installer_Partitioning - I can try to go through and move anything that's necessary to the partioning pages
- http://web.archive.org/web/20191211213224/https://wiki.voidlinux.org/Dynamic_Kernel_Module_Support - mostly need to mention where to find the build logs
- http://web.archive.org/web/20190228221119/https://wiki.voidlinux.org/Embedded_Images - is kind of the table of contents for ARM stuff, also included in the voidlinux.org/download page
- http://web.archive.org/web/20190228221315/https://wiki.voidlinux.org/Full_Disk_Encryption_w/Encrypted_Boot (this one covers "Manual install w/ fde*") + http://web.archive.org/web/20190228221355/https://wiki.voidlinux.org/Manual_Install_with_encrypted_boot
- http://web.archive.org/web/20191211213222/http://wiki.voidlinux.org/Hashboot - all relevant information is in void-docs, this page is also incorrect on several accounts
- http://web.archive.org/web/20191224070910/https://wiki.voidlinux.org/Infrastructure - should definitely go in InfraDocs if anywhere at all / don't think it's going to be documented
- http://web.archive.org/web/20190228221125/https://wiki.voidlinux.org/Install_LVM_LUKS + http://web.archive.org/web/20190228221355/https://wiki.voidlinux.org/Install_LVM_LUKS_on_UEFI_GPT - have to think about it
- http://web.archive.org/web/20190228221354/https://wiki.voidlinux.org/Install_android + https://gist.github.com/radare/7448139 - interesting, even has comment by @Johnnynator, but is more of a packaging / deployment thing than docs
- http://web.archive.org/web/20190228221122/https://wiki.voidlinux.org/Installation + http://web.archive.org/web/20190228221121/https://wiki.voidlinux.org/Installation:_UEFI + http://web.archive.org/web/20190228221118/https://wiki.voidlinux.org/Installation_On_UEFI_With_MDRAID,_via_chroot - should be partly covered, I can go through and check
- http://web.archive.org/web/20190228221125/https://wiki.voidlinux.org/Known_Issues - bootstrapping stuff, should be issues on GitHub or guides in the README. Not sure they are relevant anymore
- http://web.archive.org/web/20190228221532/https://wiki.voidlinux.org/Libinput - out of scope, indeed
- http://web.archive.org/web/20190228221336/https://wiki.voidlinux.org/Lyx:_the_document_processor - out of scope, I think
- http://web.archive.org/web/20190228221159/https://wiki.voidlinux.org/Macbook - I can try to collect some of the relevant info from there. A lot of it is fluff.
- http://web.archive.org/web/20190228221354/https://wiki.voidlinux.org/Manual_install_with_ZFS_root - badly formatted, I prefer the current PR
- Pinebook Pro page couldn't be found in web archive :o
- http://web.archive.org/web/20190228221200/https://wiki.voidlinux.org/Post_Installation - should be covered by configuration stuff, can take a closer look
- http://web.archive.org/web/20190228221318/https://wiki.voidlinux.org/Raspberry_Pi_(External_HDD_with_LUKS_%2B_Berryboot) - could be interesting to add
- http://web.archive.org/web/20190228221334/https://wiki.voidlinux.org/SANE - like the idea of putting it together with printing, though I think most of it isn't required
- http://web.archive.org/web/20190228221402/http://wiki.voidlinux.org/SaltStack_for_Void_Linux - should this be in Void Docs? If yes, how to use? Pinging @Vaelatern
- http://web.archive.org/web/20190228221336/https://wiki.voidlinux.org/Samba - doesn't have much, not sure how much of it is up to date. Pinging @abenson and @ahesford
- http://web.archive.org/web/20190228221202/http://wiki.voidlinux.org/Steam - being worked on
- http://web.archive.org/web/20190228221137/http://wiki.voidlinux.org/USB_Armory - goes in ARM devices
- http://web.archive.org/web/20190228221154/https://wiki.voidlinux.org/VirtualBox - just needs some few package names
- http://web.archive.org/web/20190228221446/https://wiki.voidlinux.org/Void_mklive - compltely covered in the repo
- http://web.archive.org/web/20190228221238/https://wiki.voidlinux.org/Xfce - has some screen tearing info that's more about Xorg than XFCE. That said, it's far from Void specific.The rest is unecessary
- http://web.archive.org/web/20190228222249/https://wiki.voidlinux.org/Xmonad - if you're using Xmonad, you should have an idea of how to deal with it yourself, IMO.
Updated the current check list with some small changes.
Regarding Samba, there is nothing specific to Void and little of general value in the archived page. I see no reason to preserve it.
I think Steam is covered by 3rd party software. It takes some doing to use the official package, but the flatpak works great.
I don't see anything that jumps out as important void specific information in xfce
@void-linux/pkg-committers: Is any of the information in https://wiki.voidlinux.org/Known_Issues still relevant?
Should the Zabbix and Zram pages be added to the checklist? The former has some Void-specific knowledge and the latter contains instructions for setting up Zram that seem to be different from any other tutorial on the subject. If so, I'd be happy to port them myself.
@cinerea0: Thanks for the offer. :-) However, as the trailing dash in the page names indicate, i believe they shouldn't be included in the Handbook:
-
the Void-specific content in the Zabbix page is basically "install these packages and enable the services", which we expect users to be able to work out for themselves, using
xbps-queryto find the packages and the Handbook to learn how to enable services. There are literally hundreds of packages with services in the repos, and we don't want a page for each. And at any rate, setting up Zabbix is not something needed for a functioning Void system. -
the Zram page basically isn't Void-specific, and the Handbook is not generally a place for non-Void-specific guides that happen to not be available elsewhere. (That's why, for example, my "D-Bus: the essentials" guide is hosted in my own repo, and not included in the Handbook.)
Re: Salt
Knowing the grains on the system is good.
Listing that the config files are under /etc/salt by default, and services are normal, is good.
Is it within the purview of the handbook to list github issues relevant to Void support in salt?
Given recent discussion on IRC, I think it would be best to remove the "Create Git Versions of Packages" entry because it's out of scope for the handbook and the details within are better covered by the xbps-src manual.
