Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.

docs: add notes about root requirements for commands#188

Merged
JTorreG merged 1 commit intomainfrom
issue-171
Jan 9, 2025
Merged

docs: add notes about root requirements for commands#188
JTorreG merged 1 commit intomainfrom
issue-171

Conversation

@JTorreG
Copy link
Copy Markdown
Collaborator

@JTorreG JTorreG commented Jan 8, 2025

Adds notes to make readers aware of which commands need to be run as root, in two ways:

  • In docs where there are 1 or 2 root commands, it adds a note in the step before the command
  • In docs with many root commands, it adds a note callout in the introductory section of the page

Closes #171

@JTorreG JTorreG self-assigned this Jan 8, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 8, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/unit/188/

@ac000
Copy link
Copy Markdown
Member

ac000 commented Jan 8, 2025

Adds notes to make readers aware of which commands need to be run as root, in two ways:

* In docs where there are 1 or 2 root commands, it adds a note in the step before the command

Is that really necessary? as that's precisely what the # signifies... (which is a well known idiom)

@JTorreG JTorreG merged commit 713d997 into main Jan 9, 2025
@JTorreG JTorreG deleted the issue-171 branch January 9, 2025 17:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Audit docs for implicit uses of sudo

3 participants