Skip to content

docs: add notes about root requirements for commands #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Conversation

JTorreG
Copy link
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
Copy link

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
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
2 checks passed
@JTorreG JTorreG deleted the issue-171 branch January 9, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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