Skip to content

Confusing mix of root and non-root commands #701

@dvuckovic

Description

@dvuckovic

Currently, installation docs contain a confusing mix of shell commands, which should be executed in both root and non-root contexts.

This is OK ✅

Image

But, this is not OK ❌

Image

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:

  1. All non-root command invocations should start just with a $ shell prefix:

    $ whoami
    non-root-user
    
  2. 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 the ansi code block or perhaps no syntax highlighting.

Metadata

Metadata

Assignees

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions