Skip to content

Gitaly docs revisions

Ben Prescott_ requested to merge bprescott/docs/20211005-gitaly into master

What does this MR do?

Revisions to Gitaly docs.

  • Sets out the current state of strong consistency
  • Documents when the virtual storage name fix was deployed. As this bug causes data loss, let's leave it in the docs so that customers running unpatched 13.x, 14.0-14.2 releases can see the need to upgrade.
  • Highlights the requirement for default. It comes up fairly regularly when customers are building separate Gitaly shards or clusters. Item five from gitaly#3424

Related issues

gitaly#3424

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.
Edited by Ben Prescott_

Merge request reports

Loading