Skip to content

No Recommendation Around Command Example in Doc Which Requires Root Privilege #17181

@vanou

Description

@vanou

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:
      1. Clear indication where root privilege is required
    • Con:
      1. dependency on tool (sudo)
  • Command example without sudo
    • Pro:
      1. concise look of doc
      2. no dependency on tool
    • Con:
      1. reader who is relatively new to *nix should run commands with try&error
      2. addition of indication where root privilege is required to doc

Proposed Solution:
To add official recommendation around this to style guide.

Page to Update:
Too many pages, cannot specify here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/featureCategorizes 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.priority/important-longtermImportant 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.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions