Skip to content
Snippets Groups Projects

Update RA docs to have additional third party DB guidance

Merged Grant Young requested to merge gy-ra-ext-db-update-docs into master
All threads resolved!

What does this MR do?

MR updates the Reference Architecture docs with expanded third party database service guidance. Namely that Praefect's can be colocated with GitLab's on such a setup.

Related issues

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

Author's checklist

If you are 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.

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 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.
  • Ensure a release milestone is set.
Edited by Grant Young

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Grant Young added 1 commit

    added 1 commit

    Compare with previous version

  • requested review from @marcel.amirault

  • removed review request for @marcel.amirault

  • Grant Young added 1 commit

    added 1 commit

    • 1dc507a3 - Apply 23 suggestion(s) to 5 file(s)

    Compare with previous version

  • Grant Young added 1 commit

    added 1 commit

    • 7a2e80cb - Add additional guidance for Geo

    Compare with previous version

  • Achilleas Pipinellis resolved all threads

    resolved all threads

  • Achilleas Pipinellis approved this merge request

    approved this merge request

  • mentioned in commit ee0346bf

  • added workflowcanary label and removed workflowstaging label

  • added workflowproduction label and removed workflowcanary label

  • Please register or sign in to reply
    Loading