Skip to content

Reference the backup timestamp doc

Anton Smith requested to merge docs/reference-backup-timestamp-doc into master

What does this MR do?

The Chart backup/restore documentation currently uses <timestamp>_<version>_gitlab_backup.tar in the docs.

This differs from Omnibus where it uses <timestamp>_gitlab_backup.tar as described https://docs.gitlab.com/ee/raketasks/backup_restore.html#backup-timestamp

This leads to confusion especially when splitting out <version> (using the following example 1677448358_2023_02_26_15.7.5-ee_gitlab_backup.tar):

  • Does <version> = 15.7.5?
  • Does <version> = 15.7.5-ee?

Let's bring the Chart backup/restore docs in alignment with Omnibus.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports