Skip to content

docs: update reference architecture: glossary, scale tests methodology #12438

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 20 commits into from
Mar 8, 2024
Merged

docs: update reference architecture: glossary, scale tests methodology #12438

merged 20 commits into from
Mar 8, 2024

Conversation

mtojek
Copy link
Member

@mtojek mtojek commented Mar 6, 2024 •
edited
Loading

Related: #12426
Preview: link

This pull request adds public-facing docs for Reference Architectures. This is the 1st part and will be merged into the feature branch. By the way, I noticed that some topics might be interleaving with Scaling Coder, so most likely the latter one will be worth editing afterward.

Covered sections:

  • Coder Glossary (admin, user, workspace, template, proxy, provisioner, registry, Kubernetes cluster for Coder)
  • Describe scale tests methodology
    • infra/setup requirements, web terminal, applications
    • traffic projections during scale tests (continuous volume, req/s, users, aggressive approach)

@mtojek mtojek self-assigned this Mar 6, 2024
@mtojek mtojek changed the title 12426 build public facing docs docs: add public-facing docs for Reference Architecture Mar 6, 2024
@mtojek mtojek changed the base branch from main to 12426-main March 7, 2024 13:38
@mtojek mtojek requested review from johnstcn and mafredri March 7, 2024 13:42
@mtojek mtojek marked this pull request as ready for review March 7, 2024 13:42
@mtojek mtojek changed the title docs: add public-facing docs for Reference Architecture docs: reference architecture: glossary, scale tests methodology Mar 7, 2024
@mtojek mtojek changed the title docs: reference architecture: glossary, scale tests methodology docs: update reference architecture: glossary, scale tests methodology Mar 7, 2024
johnstcn
johnstcn reviewed Mar 7, 2024
View reviewed changes
Copy link
Member

@johnstcn johnstcn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice writeup! Some wording suggestions below.

@mtojek mtojek mentioned this pull request Mar 7, 2024
Closed
9 tasks
johnstcn
johnstcn reviewed Mar 7, 2024
View reviewed changes
mafredri
mafredri approved these changes Mar 7, 2024
View reviewed changes
Copy link
Member

@mafredri mafredri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, thanks for writing this. I think the glossary could be moved to a separate page in the future, so we can keep this one focused on the scale testing whilst linking to the glossary.

@mtojek
Copy link
Member Author

mtojek commented Mar 8, 2024

Alright, I think I addressed all your comments, folks 👍

@mtojek mtojek merged commit fb7f1ac into 12426-main Mar 8, 2024
@mtojek mtojek deleted the 12426-build-public-facing-docs branch March 8, 2024 13:13
@github-actions github-actions bot locked and limited conversation to collaborators Mar 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mafredri mafredri mafredri approved these changes

@johnstcn johnstcn johnstcn approved these changes

Assignees

@mtojek mtojek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mtojek @mafredri @johnstcn