grammar improvements #671
grammar improvements #671
Conversation
RayBB
force-pushed
the
grammar-improvements
branch
from
d4a0688 to
676a1e9
Compare
|
|
||
| - edit `/etc/default/grub` and update `GRUB_CMDLINE_LINUX` to include `intel_iommu=on iommu=pt pcie_ports=compat` | ||
| - Apply your edits by running `sudo update-grub` on ubuntu or `sudo grub-mkconfig -o /boot/grub/grub.cfg` for other distros | ||
| - Note that, `grub`'s command line interface names might differ on different distros, if the commands like `grub-xxx` are not found, try `grub2-xxx` alternatives instead. For example, it should be `sudo grub2-mkconfig ...` instead of `sudo grub-mkconfig ...` on Fedora 36. |
There was a problem hiding this comment.
I wonder what's wrong with Note that?
There was a problem hiding this comment.
In the trainings I've done on technical writing they usually explain it something like this:
- It is redundant (if you're putting it in the docs it's already important)
- It can be a bit patronizing
- People get desensitized to it when it appears often
- If something really is important and needs to be called out then you should warning indicator or something strong
So the general recommendation is to not use it. However, I'm just providing suggestions so if you want to keep it that's no problem.
There was a problem hiding this comment.
@sharpenedblade could you provide the latest Fedora instructions? I don't think 36 is relevant anymore
|
@AdityaGarg8 I've addressed all of your feedback. Also, if you have any other stylistic preference let me know and I'll try to accommodate them. With your approval, I hope to do a few more PRs of improvements to the docs (as reported in other issues). |
Let me celebrate New Year lol. |
| - edit `/etc/default/grub` and update `GRUB_CMDLINE_LINUX` to include `intel_iommu=on iommu=pt pcie_ports=compat` | ||
| - Apply your edits by running `sudo update-grub` on ubuntu or `sudo grub-mkconfig -o /boot/grub/grub.cfg` for other distros | ||
| - Note that, `grub`'s command line interface names might differ on different distros, if the commands like `grub-xxx` are not found, try `grub2-xxx` alternatives instead. For example, it should be `sudo grub2-mkconfig ...` instead of `sudo grub-mkconfig ...` on Fedora 36. | ||
| - `grub`'s command line interface names might differ on different distros, if the commands like `grub-xxx` are not found, try `grub2-xxx` alternatives instead. For example, it should be `sudo grub2-mkconfig ...` instead of `sudo grub-mkconfig ...` on Fedora 36. |
There was a problem hiding this comment.
(This was already wrong before, but since we are changing things its better to fix this now) Fedora has a "special" grub config setup using grubby, the grub config file is mostly static and just contains disk UUIDs, so its confusing to use it as an example since users could end up trying to use grub2-mkconfig on Fedora.
4 participants
Followup to #668
Here's I'm making overall grammar improvements rather than the simple typos found by codespell.
Some of these are a bit more subjective but my overall goal is to improve readability.
I'll also note that we probably should use a template for the part about needing a usb stick, adapter, etc but that can be a change for later.