Skip to content

Reorganize back up and restore docs

What does this MR do?

  • Reorganizes back up and restore docs because it is very confusing.
    • Move back up docs from doc/raketasks/ to doc/administration/backup_restore/ because:
      1. the back up command is no longer just a rake task
      2. much of the docs discuss more than just the back up command
      3. we need a top-level, general backup/restore document anyway
    • Move back-up-specific sections from the top-level doc to the "Back up GitLab" doc
  • Explain more about what the backup command is trying to accomplish, to help users extrapolate the docs to apply to their specific use case.

MR to adjust docs.gitlab.com nav links: gitlab-docs!3998 (closed)

Related issues

#396346 (closed)

Author's checklist

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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 Michael Kozono

Merge request reports

Loading