Skip to content

Add notes for Disk Types, Object Storage and Monitoring in Ref Arch docs

Grant Young requested to merge gy-disk-type-note-ra-docs into master

What does this MR do?

MR adds a note about general Disk Type requirements in the Reference Architecture docs.

An area of balance, we call out the minimum requirements for components such as GitLab and avoiding the use of burstable disk types but leave the choice ultimately to customers depending on requirements on their end such as costs, durability and backup strategies, etc...

MR also adds a link to the supported Object Storage provider docs and give general guidance (reputable and S3 compatible) as well as add some more detail into the Monitoring section on the main page.

Author's checklist

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.
Edited by Grant Young

Merge request reports

Loading