Removes and redirects cells design documents
What does this MR do?
We are currently migrating the Architecture design documents from the gitlab project to the public handbook.
gitlab-com/content-sites/handbook!7085 (merged) adds the cells design documents to the handbook (plus a hidden design doc for notes table partitioning) and missing redirects for backup_and_restore
and secret_manager
. See table on the migration issue). Now this MR removes the original documents from the gitlab repository and instead adds redirects to the handbook. It also adds a redirect to the main "old" blueprints page. This MR wraps up the design documents migration.
Excerpt from design docs table. These documents are in this MR.
Design document folder | Creation Date | Migrated? | Redirect? |
---|---|---|---|
cells | 2022-09-07 |
|
|
notes_table_partitioning | 2023-12-22 |
|
|
backup_and_restore | gitlab-com/content-sites/handbook!7085 (merged) | ||
secret_manager | Redirect for index.md was missing |
Related issues
Move Architecture Blueprints to Public Handbook (gitlab-com/content-sites/handbook#279 - closed)
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.