Separate out migrate to new server topics
What does this MR do?
While reviewing !138129 (merged), it occurred to me that some task information probably belonged on it's own page, like most of the other task information.
That would create space for more conceptual information about backups and restores in general, if needed.
- Before: https://docs.gitlab.com/ee/administration/backup_restore/index.html#migrate-to-a-new-server
- After: https://main-ee-138135.docs.gitlab-review.app/ee/administration/backup_restore/migrate_to_new_server.html
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.7
assigned to @eread
added sectioncore platform label
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/backup_restore/migrate_to_new_server.md
(Link to current live version) -
doc/administration/backup_restore/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
DangerEdited by Ghost User-
added docs-only label
- Resolved by Achilleas Pipinellis
@proglottis Could you review this one? It's almost completely a lift-and-shift with very few tweaks required.
If it looks good, could you send to
@axil
for review and merge?Edited by Evan Read
requested review from @proglottis
mentioned in merge request !138129 (merged)
mentioned in merge request gitlab-docs!4430 (merged)
requested review from @axil and removed review request for @proglottis
- Resolved by Evan Read
added 645 commits
-
f1e932b9...532a65fa - 643 commits from branch
master
- 32adb2c3 - Separate out migrate to new server topics
- cd316f40 - Apply 1 suggestion(s) to 1 file(s)
-
f1e932b9...532a65fa - 643 commits from branch
enabled an automatic merge when the pipeline for 50540f22 succeeds