Adjust Reference Architecture terminology
What does this MR do?
MR adjusts terminology in the Reference Architecture documentation to further reflect they are designed for the peak load their user counts typically by adjusting the titles as follows:
- Up to 20 RPS or 1,000 users
- Up to 40 RPS or 2,000 users
- Up to 100 RPS or 5,000 users
- Up to 200 RPS or 10,000 users
- Up to 500 RPS or 25,000 users
- Up to 1000 RPS or 50,000 users
The new titles surface the Requests per Second targets right to the top with the aim here to encourage users to always consider this from the off as well as highlight that for customers with a low user count but a higher RPS then they should adjust accordingly. The "Selecting" guide in the main index page has been adjusted to reflect this also.
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.