Gitlab dedicated disaster recovery docs
What does this MR do?
- Adds details on GitLab Dedicated disaster recovery process and objectives to customer-facing docs. Based on:
- @cbalane's Google Doc
- Disaster recovery plan described in the Handbook
- Adds details about GitLab Dedicated SLAs to the Subscription page, to move this from the Handbook page
MR to add new disaster recovery page to navigation: Add GitLab Dedicated disaster recovery doc to n... (gitlab-org/technical-writing/docs-gitlab-com!769 - merged)
Related issues
- Draft: Add GitLab Dedicated Disaster Recovery d... (!187505 - closed)
- https://gitlab.com/gitlab-com/gl-infra/gitlab-dedicated/team/-/issues/7906+
- https://gitlab.com/gitlab-com/gl-infra/gitlab-dedicated/team/-/issues/8832+
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
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.
Edited by Emily Sahlani