Docs: AWS Gitaly SRE Updates, Clarify Depreciation, Ests & disclaims
What does this MR do?
- Made the Gitaly SRE performance engineering for AWS recommendations more clear and link out to relevant AWS docs.
- Refined the lead in to Gitaly SRE section to surface the necessity for it and the innovation it reflects.
- Removed "DEPRECATED" from Omnibus docs title level and moved it to a note, because as @grantyoung predicted it cause confusion that the Omnibus arch was depreciating (sorry forgot to change on last MR).
- Completed calculators for other CNH configs - also added clarifying notes and disclaimers to cost calculator table.
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
Review 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 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. - 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Direct Links Into Review App Where Changes Were Made
Edited by DarwinJS