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(server): full copy-edit of auth mode page #13137

Merged
merged 2 commits into from
Jun 12, 2024

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jun 2, 2024

I linked to this in Slack recently and realized how dated it was 😬
Also aligns with my other docs copy-edit PRs

Motivation

  • this page had some out-of-date information, had inconsistent terminology, and lacked links to several of the features it mentioned
    • it sorely needed an update

Modifications

  • remove outdated statement about RBAC mapping

  • terminology & consistency improvements:
    • "choose" -> "configure"
    • "which kube config" -> how to "authenticate"
      • there is no kube config in some of these cases either, so this terminology was not only inconsistent with the rest of the docs (and itself), but also very confusing
      • also that an SA generates a kube config is a k8s implementation detail that not all users are aware of. stick to a higher level description
    • consistently capitalize "Server"
    • use "v{version} and after" consistently, per docs: consistently use "> v{version} and after" #12581
      • also mention the current default first, not the old default
        • the current has been around for years and is more important than the old one, so it should be first
      • remove the redundant SSO version references here as they are already listed in more consistent style within the linked pages
    • use code backticks consistently when referring to one of the modes and when referring to the CLI flag
  • add links to mentioned features:
    • to hosted mode vs. local mode
    • to k8s bearer token docs
    • to SSO and NS delegation

Verification

make docs passes

Future Work

This page is pretty tiny, it might make sense to merge with the general Argo Server page, which links to this page, which then links back to it 😕

- this page had some out-of-date information, had inconsistent terminology, and lacked links to several of the features it mentioned
  - it sorely needed an update

- remove outdated statement about RBAC mapping
  - this feature has existed since SSO RBAC NS delegation was implemented, so replace with a link to that feature

- terminology & consistency improvements:
  - "choose" -> "configure"
  - "which kube config" -> how to "authenticate"
    - there is no kube config in some of these cases either, so this terminology was not only inconsistent with the rest of the docs (and itself), but also very confusing
    - also that an SA generates a kube config is a k8s implementation detail that not all users are aware of. stick to a higher level description
  - consistently capitalize "Server"
  - use "v{version} and after" consistently, per my previous PRs
    - also mention the current default first, not the old default
      - the current has been around for years and is more important than the old one, so it should be first
    - remove the SSO version references here as they are already listed in more consistent style within the linked pages
  - use code backticks consistently when referring to one of the modes and when referring to the CLI flag

- add links to mentioned features
  - to hosted mode vs. local mode
  - to k8s bearer token docs
  - to SSO and NS delegation

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/sso-rbac area/server labels Jun 2, 2024
@agilgur5 agilgur5 added this to the v3.4.x patches milestone Jun 2, 2024
- my bad, I think I might have never used them separately and had forgotten

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5 agilgur5 added the prioritized-review For members of the Sustainability Effort label Jun 10, 2024
@Joibel Joibel merged commit 682755f into argoproj:main Jun 12, 2024
18 checks passed
@agilgur5 agilgur5 deleted the docs-auth-mode-copy-edit branch June 12, 2024 13:35
agilgur5 added a commit that referenced this pull request Jun 14, 2024
Signed-off-by: Anton Gilgur <[email protected]>
(cherry picked from commit 682755f)
agilgur5 added a commit that referenced this pull request Jun 14, 2024
Signed-off-by: Anton Gilgur <[email protected]>
(cherry picked from commit 682755f)
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/server area/sso-rbac prioritized-review For members of the Sustainability Effort
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants