Update RA docs to have additional third party DB guidance
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
-
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.
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 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. -
Ensure a release milestone is set.
Merge request reports
Activity
changed milestone to %14.6
requested review from @marcel.amirault
assigned to @grantyoung
@marcel can you review? This is approved by Stan
1 Warning 9631579c: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/administration/reference_architectures/10k_users.md
doc/administration/reference_architectures/25k_users.md
doc/administration/reference_architectures/2k_users.md
doc/administration/reference_architectures/3k_users.md
doc/administration/reference_architectures/50k_users.md
doc/administration/reference_architectures/5k_users.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangeradded sectioncore platform label
- Resolved by Achilleas Pipinellis
Hey @grantyoung! @axil is back from his leave, so the lucky fella gets to handle all the groupdistribution docs MRs again
Edit: I made a quick suggestion to hopefully fix the pipeline
Edited by Marcel Amirault
requested review from @axil and removed review request for @marcel.amirault
added Technical Writing docsimprovement labels
- Resolved by Achilleas Pipinellis
requested review from @marcel.amirault
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
- Resolved by Grant Young
removed review request for @marcel.amirault
mentioned in commit ee0346bf
mentioned in issue gitlab-org/quality/reference-architectures#44 (closed)
added workflowstaging-canary label
added workflowstaging label and removed workflowstaging-canary label
added workflowcanary label and removed workflowstaging label
added workflowproduction label and removed workflowcanary label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label