Align console prompts to style guide (administration) #184

brettweir · 2026-06-19T10:33:16Z

brettweir commented

2026-06-19 10:33:16 +00:00

This PR aligns console prompts in the administration section with the Fedora style guide. Specifically, the following changes have been made:

[…]#/[…]$ have been changed to #/$ respectively.
[source,] has been changed to [source,console]

Since console prompts appear in a large number of places, this change is implemented across multiple PRs to make reviewing easier. Corrections regarding use of the root user have also been excluded.

This PR aligns console prompts in the **administration** section with the Fedora style guide. Specifically, the following changes have been made: - `[…]#`/`[…]$` have been changed to `#`/`$` respectively. - `[source,]` has been changed to `[source,console]` Since console prompts appear in a large number of places, this change is implemented across multiple PRs to make reviewing easier. Corrections regarding use of the `root` user have also been excluded.

brettweir added 1 commit

2026-06-19 10:33:17 +00:00

Align console prompts to style guide (administration) 0d2b2dc28d

goroboro reviewed

2026-06-19 10:59:05 +00:00

modules/ROOT/pages/administration/dnsmasq.adoc

					
				@ -39,2 +38,3 @@

				[source,console]

				----

				[…]# firewall-cmd --get-active-zones

				# firewall-cmd --get-active-zones

As with most of the root run commands in this, I would change to user run with sudo and prefix with $.
Running things as root is just bad practice and we should generally discourage being in a root shell. Certainly, modern Fedora doesn't even enable the root account for shell access by default, so it doesn't really make sense to instruct users to do this if it isn't easy to do.
One thing to be aware of is that you can't just prefix everything with sudo and be done with it. For example, later in your doc you have lines like:
echo 1 > /proc/sys/net/ipv4/ip_forward
This would translate as:
echo 1| sudo tee /proc/sys/net/ipv4/ip_forward

Finally, there are many commands listed in this doc, that probably don't require root access and we should try to correct this rather than lazily assuming all commands require root -- this is no critique on your work, by the way. The changes you have made here are already an improvement. You could consider doing sudo changes etc as a separate PR, if you're more comfortable with that. Or leave it to someone else to do! :)

As with most of the root run commands in this, I would change to user run with sudo and prefix with $. Running things as root is just bad practice and we should generally discourage being in a root shell. Certainly, modern Fedora doesn't even enable the root account for shell access by default, so it doesn't really make sense to instruct users to do this if it isn't easy to do. One thing to be aware of is that you can't just prefix everything with sudo and be done with it. For example, later in your doc you have lines like: echo 1 > /proc/sys/net/ipv4/ip_forward This would translate as: echo 1| sudo tee /proc/sys/net/ipv4/ip_forward Finally, there are many commands listed in this doc, that probably don't require root access and we should try to correct this rather than lazily assuming all commands require root -- this is no critique on your work, by the way. The changes you have made here are already an improvement. You could consider doing sudo changes etc as a separate PR, if you're more comfortable with that. Or leave it to someone else to do! :)