Skip to content

Add section in Ref Arch docs around decisions

Grant Young requested to merge gy-clearer-decision-guidance-ra-docs into master

What does this MR do?

MR converts the Availability Components section of the Reference Architecture docs into a more streamlined How to decide what architecture to use section to give clearer guidance on the levers a user has to decide what RA to use with details on each.

Goal here is to make it clearer for the end user on the trade offs of each type and precent users from selecting an architecture too complex for their needs.

Related issues

Closes gitlab-org/quality/reference-architectures#160 (closed)

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 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.

Direct Link to Relevant Review App Location

More important since this contains a real-time generated diagram.

http://main-ee-98204.35.193.151.162.nip.io/ee/administration/reference_architectures/index.html#deciding-on-what-architecture-to-use

Edited by DarwinJS

Merge request reports