kubernetes / kubernetes/website

Pod Security Standards: Usage of SHOULD and MUST

Open Beginner friendly
#56,806 1 comment 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

The web page https://kubernetes.io/docs/concepts/security/pod-security-standards/
should follow RFC 2119 in the use of SHOULD and MUST.

There are some occasions where the word "should is used but it's wrong:

In the section "Restricted":

> The following listed controls _should_ be enforced/disallowed:

In the table, entry "Privilege Escalation (v1.8+)":

> Privilege escalation (such as via set-user-ID or set-group-ID file mode) _should_ not be allowed.

The spec value lists no allowed values.

In both cases, it should be "MUST", not "should".

I recommend reviewing the use of should in the entire page, I only looked at the "restricted" section.

Contributor guide

Open the contributing guide

Research direction

Start with the Pod Security Standards page at https://kubernetes.io/docs/concepts/security/pod-security-standards/ and review its use of “should” against RFC 2119. Correct the two identified statements in the Restricted section and inspect the rest of the page for similar SHOULD/MUST wording; done means the page uses the terms consistently with the specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.