Issue #210 - Add Fedora Server style conventions to help guide contribution and to track decisions made by the Fedora Server SIG/WG #202

goroboro · 2026-07-16T10:18:14Z

goroboro commented

2026-07-16 10:18:14 +00:00

This is a very basic first attempt at providing a location to track style conventions agreed by the Fedora Server WG that might go beyond the standard Fedora Docs style guide. This can probably be improved on as we include more conventions, or perhaps many of these conventions might eventually make their way into the general style guide. We can review again at a later date.

goroboro added 1 commit

2026-07-16 10:18:14 +00:00

Issue #210 - Add Fedora Server style conventions to help guide contribution and to track decisions made by the Fedora Server SIG/WG 6de9e5652f

goroboro added 1 commit

2026-07-16 10:18:23 +00:00

Merge branch 'main' into ISSUE210-style 20935b4f53

brettweir approved these changes

2026-07-17 04:58:04 +00:00

brettweir left a comment

This is an excellent addition. I added a couple comments but this is a great starting point for codifying our doc style.

STYLE.md

					
				@ -0,0 +30,4 @@

				----

				```

				TIP: By quoting the 'EOF' in the command, you can often avoid bash variable expansion if the file contains variable strings. Read more on HEREDOC at [The Linux Documentation Project](https://tldp.org/LDP/abs/html/here-docs.html).

The use of "often" here conveys doubt. Does it avoid variable expansion? I suggest being more definitive, but if you know specifically of situations where it doesn't avoid expansion, you can say "you can avoid bash variable expansion, excepting for scenarios where ..."

STYLE.md

					
				@ -0,0 +68,4 @@

				$ sudo echo 1 > /proc/sys/net/ipv4/ip_forward

				```

				The redirect will run as the standard user and only the echo will run under sudo. Instead, run the echo as the standard user and pipe the output to tee running under sudo:

One notable addition to this style guide would be the use of inline code via backticks. I like to use this for explicit command names, function names, and file names.

Run the echo command and pipe to tee using sudo to output to /etc/config.ini.

One notable addition to this style guide would be the use of inline code via backticks. I like to use this for explicit command names, function names, and file names. > Run the `echo` command and pipe to `tee` using `sudo` to output to `/etc/config.ini`.