Restructure Gitaly and Gitaly Cluster introduction
What does this MR do?
Improved the order and presentation of information in the Gitaly and Gitaly Cluster introductory information.
- Before: https://docs.gitlab.com/ee/administration/gitaly/index.html
- After: http://main-ee-65303.178.62.207.141.nip.io/ee/administration/gitaly/index.html
Some key points:
- Landing page now has more introductory material, a combination of:
- Because the decision to use virtual storage seems critical to whether to choose Gitaly or Gitaly Cluster, that information is brought higher up as part of moving https://docs.gitlab.com/ee/administration/gitaly/#virtual-storage-or-direct-gitaly-storage up.
- Use the simple example here: https://docs.gitlab.com/ee/administration/gitaly/#virtual-storage-or-direct-gitaly-storage now as a simple Gitaly example.
- Gitaly Cluster overview: https://docs.gitlab.com/ee/administration/gitaly/#overview is brought up to be at the top of the Gitaly Cluster information, instead of quite far down.
- The Cluster example: https://docs.gitlab.com/ee/administration/gitaly/#components-of-gitaly-cluster now comes up earlier.
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
Ensure that the product tier badge is added to doc's h1
. -
Request a review based on the documentation page's metadata and associated Technical Writer.
To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database
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 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Edited by Evan Read