Skip to content

WIP: Use imperative for headings in the backup/restore doc

Achilleas Pipinellis requested to merge axil-backup-docs-refactor into master

What does this MR do?

A small refactor for the backup/restore docs:

  • Use imperative for headings
  • Most notably, change the H1 to mention backup so it appears to the top of the list when you search in the docs site, which is not the case for now Screenshot_2020-04-29_10-33-23

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Achilleas Pipinellis

Merge request reports

Loading