-
Notifications
You must be signed in to change notification settings - Fork 15.3k
No Recommendation Around Command Example in Doc Which Requires Root Privilege #17181
Copy link
Copy link
Closed
Labels
kind/featureCategorizes issue or PR as related to a new feature.Categorizes issue or PR as related to a new feature.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.Denotes an issue or PR that has aged beyond stale and will be auto-closed.priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.Important over the long term, but may not be staffed and/or may need multiple releases to complete.sig/docsCategorizes an issue or PR as relevant to SIG Docs.Categorizes an issue or PR as relevant to SIG Docs.
Description
This is a Bug Report
Problem:
In K8s doc, there are command examples which require root privilege. But there is inconsistency of use of sudo command in example (e.g. here&here with sudo but here without).
However there are pros&cons:
- Command example with
sudo- Pro:
- Clear indication where root privilege is required
- Con:
- dependency on tool (
sudo)
- dependency on tool (
- Pro:
- Command example without
sudo- Pro:
- concise look of doc
- no dependency on tool
- Con:
- reader who is relatively new to *nix should run commands with try&error
- addition of indication where root privilege is required to doc
- Pro:
Proposed Solution:
To add official recommendation around this to style guide.
Page to Update:
Too many pages, cannot specify here.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
kind/featureCategorizes issue or PR as related to a new feature.Categorizes issue or PR as related to a new feature.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.Denotes an issue or PR that has aged beyond stale and will be auto-closed.priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.Important over the long term, but may not be staffed and/or may need multiple releases to complete.sig/docsCategorizes an issue or PR as relevant to SIG Docs.Categorizes an issue or PR as relevant to SIG Docs.