Add more guidance for external Redis services
What does this MR do?
Adds some more guidance for external Redis service setup in the documentation. Specifically around the separated Cache and Persistent instances.
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 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.
Merge request reports
Activity
changed milestone to %16.5
requested review from @axil
assigned to @grantyoung
- Resolved by Achilleas Pipinellis
Ready for review @axil, thanks!
1 Warning 1c745bb8: 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/redis/replication_and_failover_external.md
(Link to current live version) -
doc/administration/reference_architectures/10k_users.md
(Link to current live version) -
doc/administration/reference_architectures/25k_users.md
(Link to current live version) -
doc/administration/reference_architectures/2k_users.md
(Link to current live version) -
doc/administration/reference_architectures/3k_users.md
(Link to current live version) -
doc/administration/reference_architectures/50k_users.md
(Link to current live version) -
doc/administration/reference_architectures/5k_users.md
(Link to current live version) -
doc/administration/reference_architectures/index.md
(Link to current live version)
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
Danger-
- Resolved by Grant Young
added docs-only label
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
added Technical Writing devopssystems groupdistribution labels
added sectioncore platform label
enabled an automatic merge when the pipeline for d7676a95 succeeds
mentioned in commit e36e9d8e
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label