Update dnsmasq.adoc to use sudo commands where relevant and to avoid using vim in commands #193

Merged

pboy merged 3 commits from goroboro/user-documentation:dnsmasq-root into main

2026-07-15 11:31:52 +00:00

goroboro commented

2026-07-06 14:27:28 +00:00

Member

This PR is an improvement to dnsmasq.adoc to use '$ sudo' in codeblocks, rather than '# ' which aligns with our style guide recommendation.
I validated commands to check whether or not root privileges were required to run them, and didn't include sudo when a command didn't require elevated privileges.
In some codeblock examples, vim was previously used to indicate an edit to a file. This requires a user to understand and navigate a particular editor which some users find difficult. I replaced these with HEREDOC syntax to pipe content directly into files. A user can edit the content before they copy/paste into the command line. This helps to avoid editor related issues when performing basic setup. The user can opt to open the file in any editor they prefer if they need to perform subsequent edits.

This PR is an improvement to dnsmasq.adoc to use '$ sudo' in codeblocks, rather than '# ' which aligns with our style guide recommendation. I validated commands to check whether or not root privileges were required to run them, and didn't include sudo when a command didn't require elevated privileges. In some codeblock examples, vim was previously used to indicate an edit to a file. This requires a user to understand and navigate a particular editor which some users find difficult. I replaced these with HEREDOC syntax to pipe content directly into files. A user can edit the content before they copy/paste into the command line. This helps to avoid editor related issues when performing basic setup. The user can opt to open the file in any editor they prefer if they need to perform subsequent edits.

goroboro added 1 commit

2026-07-06 14:27:28 +00:00

Update dnsmasq.adoc to use sudo commands where relevant and to avoid using vim in commands which requires a user to understand and navigate a particular editor. I used HEREDOC syntax to pipe content into files. A user can edit the content before they copy/paste into the command line. 972f693217

goroboro added 1 commit

2026-07-06 16:08:23 +00:00

Merge branch 'main' into dnsmasq-root 2f360f7221

goroboro added 1 commit

2026-07-09 09:40:59 +00:00

Improvements to writes to config files - as discussed in Fedora Server meeting. We opted not to use HEREDOC, and to not specify which editor to use. I also took the opportunity to do some further clarification on variable substitutions. 5a2fd40aea