Skip to content
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

docs: fix typos and simplify wording on SSO page #11341

Merged
merged 3 commits into from
Jul 12, 2023

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 11, 2023

Motivation

  • Stumbled upon some typos on the page
  • Use simpler and more direct language, per the k8s style guide
    • there are (many) more changes that could be made to the docs according to the k8s style guide, but (significantly) limited myself right now to places I'm already applying fixes to 😅
      • didn't want to do wholesale copy-editing of all docs at this point 😅
      • for example, using "you" and avoiding "we", which are switched between many times in the docs. (also, replacing "latin phrases", etc etc)

Modifications

  • fix missing spaces, fix missing article ("an", "a")

  • use code backticks when referring to a namespace

  • simpler + more direct language:

    • "which would allow" -> "that allows" (also prefer present tense)
    • "we will use this to allow" -> "this allows"
    • "that you want to grant to" -> "for"
    • "whenever" -> "when"
    • "we will use this service account to allow" -> "this service account allows"
  • reduce repetition

    • "if you wish to" is redundant when it is "optional"
    • "in the namespace" is redundant when it is initially stated that "makes a request in my-namespace"

Verification

n/a

- missing spaces, missing article ("an")

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
- Use simpler and more direct language, per the [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)
  - "that you want to grant to" -> "for"
  - "we will use this service account to allow" -> "this service account allows"

- there are (many) more changes that could be made to the docs according to the k8s style guide, but limiting myself right now to places I'm already editing 😅

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
- "which would allow" -> "that allows" (see also https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense)
- "we will use this to allow" -> "this allows"

- reduce repetition
  - "if you wish to" is redundant when it is "optional"
  - "in the namespace" is redundant when it is initially stated that "makes a request in `my-namespace`"

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@terrytangyuan terrytangyuan enabled auto-merge (squash) July 12, 2023 13:41
@terrytangyuan terrytangyuan merged commit 22d8461 into argoproj:master Jul 12, 2023
25 checks passed
@agilgur5 agilgur5 deleted the docs-sso-typos branch July 12, 2023 14:33
tico24 pushed a commit to tico24/argo-workflows that referenced this pull request Jul 13, 2023
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Tim Collins <tim@thecollins.team>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/sso-rbac labels Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs area/sso-rbac
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants