-
Notifications
You must be signed in to change notification settings - Fork 128
Description
Currently, installation docs contain a confusing mix of shell commands, which should be executed in both root and non-root contexts.
This is OK ✅

But, this is not OK ❌

Both first and second block look identical, but the second one is misleading: all commands still require root context, even though the sudo
prefix is missing in them.
Consider introducing the following convention:
-
All non-root command invocations should start just with a
$
shell prefix:$ whoami non-root-user
-
All root command invocations should start either with a
$ sudo
prefix or just with a#
shell prefix:$ sudo make me a sandwich
or
# make me a sandwich
NOTE: I acknowledge that syntax highlighting may be off when using shell code blocks with
#
prefix, as they are considered comments in shell scripts. However, I'd like to posit that using shell syntax highlighting in such code blocks is just plain wrong. These are actually shell commands, not a script. More correct would be theansi
code block or perhaps no syntax highlighting.