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: back-link the two separate scaling pages #11296

Merged

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 5, 2023

Motivation

  • "Running At Massive Scale" is in the User Guide, while "Scaling" (along with HA, DR, etc) is in the Operator Guide
    • link the two to each other as they have different information
      • rate limit and GC in one, horizontal and vertical scaling and sharding in the other
        • I was actually looking for docs on rate limiting after finding some config for it, but couldn't find it in the Operator Guide. Stumbled upon it later in the User Guide.

Modifications

  • Add a "Miscellaneous" section in both docs that has one sentence that links to the other

Verification

n/a

Review Notes

Should these pages be consolidated into one?
I'm not sure why one was put into the User Guide vs. the Operator Guide though, so don't know the original rationale. As a user, it does instill some confidence that Argo can scale quite a bit, so I could potentially assume some rationale there.
But I would think all the config details would be left to the Operator Guide and the User Guide would just have a summary of benchmarks or something and then just link to the Operator Guide for how to achieve those numbers via configuration.

- "Running At Massive Scale" is in the User Guide, while "Scaling" (along with HA, DR, etc) is in the Operator Guide
  - link the two to each other as they have different information
    - rate limit and GC in one, horizontal and vertical scaling and sharding in the other

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@terrytangyuan terrytangyuan enabled auto-merge (squash) July 5, 2023 17:33
@terrytangyuan terrytangyuan merged commit 30a9168 into argoproj:master Jul 5, 2023
24 checks passed
@agilgur5 agilgur5 deleted the docs-scaling-masssive-scale branch July 5, 2023 18:08
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants