Project

General

Profile

Actions

Idea #21885

open

Adjust our documentation to assume users use sudo

Added by Brett Smith 6 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
-
Start date:
Due date:
Story points:
-

Description

Our documentation is currently written in a style where commands to run as a regular user are denoted with $, and commands to run as root are denoted with #. This has a few problems:

  • The single character is easy to miss, especially when documentation jumps back and forth between them without much notice.
  • That character makes copy-paste more difficult.
  • The convention is only documented once, so if you go to a specific documentation page you probably won't know about this.

Proposal: just rewrite all our commands to use sudo when they need privileges. It solves the first two problems directly, and its use has become so common there's basically no reason not to.

We'll probably have to revisit this if run0 starts getting uptake, but I think this switch will still put us in a better position to do that when/if the time comes.

No data to display

Actions

Also available in: Atom PDF