Remove content from FAQ and distribute to other locations
What does this MR do?
Contributes to: #347257.
Brings FAQ information into section of the documentation where it is most relevant.
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#how-does-gitaly-cluster-compare-to-geo
- After: http://main-ee-88364.35.193.151.162.nip.io/ee/administration/gitaly/index.html#comparison-to-geo
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#are-there-instructions-for-migrating-to-gitaly-cluster
- After: Removed, because was just a cross link.
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#what-are-some-repository-storage-recommendations
- After: http://main-ee-88364.35.193.151.162.nip.io/ee/administration/gitaly/praefect.html#repository-storage-recommendations
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#what-are-some-praefect-database-storage-requirements
- After: http://main-ee-88364.35.193.151.162.nip.io/ee/administration/gitaly/praefect.html#running-gitlab-and-praefect-database-on-same-server
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#is-pgbouncer-required-for-the-praefect-database
- After: Rolled into http://main-ee-88364.35.193.151.162.nip.io/ee/administration/gitaly/praefect.html#use-pgbouncer
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#are-there-any-special-considerations-for-gitaly-cluster-when-postgresql-is-upgraded
- After: http://main-ee-88364.35.193.151.162.nip.io/ee/administration/gitaly/praefect.html#requirements
- Before: https://docs.gitlab.com/ee/administration/gitaly/faq.html#praefect-database-tables-are-empty
- After: Rolled into http://main-ee-88364.35.193.151.162.nip.io/ee/administration/gitaly/praefect.html#postgresql
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 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 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Evan Read