CRUX Handbook: Grammar and layout issues
Hello, I've been looking into CRUX a bit on the weekend and found quite a few issues with the text of the current Handbook while reading it. So, here are the ones I've recorded so far (with fixes), ordered by section: Section 2.2 * “The usage of ports helps keep your packages up-to-date…” * up-to-date -> up to date * “If you are using CRUX we highly recommend to subscribe to our low volume mailing list, because security updates and updates that need user action are announced there .” * Insert comma after “CRUX”. * to subscribe -> subscribing * low volume -> low-volume * Omit comma after “because”. * Omit space before period. Section 2.3.2 * “…licensed through the GNU General Public License.” * I'd just make that “released under the GNU General Public License.” (That's GNU's own wording. Cf. https://www.gnu.org/licenses/gpl-howto.html) Section 3 * Heading is missing top margin. Section 3.1 * “A minimum of 768MB system memory is required to install CRUX from CD-ROM or removable flash drive.” * Insert “a” before “CD-ROM”. * “The kernel used during installation, i.e. when booting from the CRUX ISO image…” * Add comma after “i.e.”. Section 3.2 * The first sentence should not be formatted as a list item. * “You will be automatically logged in as as root on tty1 (root has no password set).” * Omit superfluous “as”. * I'd also move “automatically” before “be”. * “CRUX supports all the filesystems supported as root filesystems by the linux kernel:” * linux -> Linux * “…the day you want to upgrade/reinstall/remove your system.” * I'd say “upgrade, reinstall or remove”. * “Make sure the appropriate userspace filesystem-tools are installed.” * filesystem-tools -> filesystem tools * The 4th code bock is missing the mount command for /home. * “If you missed/forgot to install certain packages, you can just mount the CRUX installation media and use pkgadd to install them.” * missed/forgot -> missed or forgot * the CRUX installation media -> the CRUX installation medium * “Remove the CRUX installation media from your computer and reboot from harddisk.” * media -> medium Section 3.3 * “You will be automatically logged in as as root on tty1 (root has no password set).” * Omit superfluous “as”. * I'd also move “automatically” before “be”. * “…to determine which files to upgrade, and which files to not upgrade.” * to not upgrade -> not to upgrade Section 4 * Heading is missing top margin. * “The following sections will in short describe how to use the package utilities.” * Move “in short” behind “describe”. Section 4.4 * “The contents of the function can differ significantly if the program is build in some other way…” * build -> built * “Please see the PortGuidelines for additional information.''” * Omit single quotes after the period. That's it so far. Nice web design, by the way. -- Michael
On Mon, Jan 27, 2020 at 07:59:23PM +0100, Michael Siegel wrote:
Hello,
Hello Michael,
I've been looking into CRUX a bit on the weekend and found quite a few issues with the text of the current Handbook while reading it.
thanks for your work, I've added your fixes to the handbook for the upcoming CRUX 3.6 [1]. Greetings Juergen [1] https://crux.nu/Main/Handbook3-6
Hi there, I've just seen the news of the 3.6 release on DistroWatch. A look into the current version of the Handbook suggests that, somewhere along the way to 3.6, someone decided to fix all the issues I had posted to this list in January (quoted at the end, for your convenience). Thanks for that! Now, I went through all of that again and found three items that haven't (really) been fixed. Here they come again: 2.2. Why use CRUX? * "If you are using CRUX, we highly recommend to subscribing to our low-volume mailing list…" * "to subscribing" -> subscribing 3.2. Installing From CD-ROM or removable flash drive * NEW: Well, first of all, "From" should really be "from" in the heading. The same goes for 3.3. Back to 3.2.: * The 4th code bock is missing the mount command for /home. * "Remove the CRUX installation media from your computer and reboot from harddisk." * "media" -> medium 4.4. Creating Packages * "Please see the PortGuidelines for additional information.''" * Omit single quotes after the period. There's kind of a lot more. I might get to that in the near future. -- Michael Am Mon, 27 Jan 2020 19:59:23 +0100 schrieb Michael Siegel <msi@malbolge.net>:
Section 2.2
* “The usage of ports helps keep your packages up-to-date…” * up-to-date -> up to date
* “If you are using CRUX we highly recommend to subscribe to our low volume mailing list, because security updates and updates that need user action are announced there .” * Insert comma after “CRUX”. * to subscribe -> subscribing * low volume -> low-volume * Omit comma after “because”. * Omit space before period.
Section 2.3.2
* “…licensed through the GNU General Public License.” * I'd just make that “released under the GNU General Public License.” (That's GNU's own wording. Cf. https://www.gnu.org/licenses/gpl-howto.html)
Section 3
* Heading is missing top margin.
Section 3.1
* “A minimum of 768MB system memory is required to install CRUX from CD-ROM or removable flash drive.” * Insert “a” before “CD-ROM”.
* “The kernel used during installation, i.e. when booting from the CRUX ISO image…” * Add comma after “i.e.”.
Section 3.2
* The first sentence should not be formatted as a list item.
* “You will be automatically logged in as as root on tty1 (root has no password set).” * Omit superfluous “as”. * I'd also move “automatically” before “be”.
* “CRUX supports all the filesystems supported as root filesystems by the linux kernel:” * linux -> Linux
* “…the day you want to upgrade/reinstall/remove your system.” * I'd say “upgrade, reinstall or remove”.
* “Make sure the appropriate userspace filesystem-tools are installed.” * filesystem-tools -> filesystem tools
* The 4th code bock is missing the mount command for /home.
* “If you missed/forgot to install certain packages, you can just mount the CRUX installation media and use pkgadd to install them.” * missed/forgot -> missed or forgot * the CRUX installation media -> the CRUX installation medium
* “Remove the CRUX installation media from your computer and reboot from harddisk.” * media -> medium
Section 3.3
* “You will be automatically logged in as as root on tty1 (root has no password set).” * Omit superfluous “as”. * I'd also move “automatically” before “be”.
* “…to determine which files to upgrade, and which files to not upgrade.” * to not upgrade -> not to upgrade
Section 4
* Heading is missing top margin.
* “The following sections will in short describe how to use the package utilities.” * Move “in short” behind “describe”.
Section 4.4
* “The contents of the function can differ significantly if the program is build in some other way…” * build -> built
* “Please see the PortGuidelines for additional information.''” * Omit single quotes after the period.
participants (2)
-
Juergen Daubert -
Michael Siegel