Gitaly doc revisions - network time, praefect replica paths, GC server hooks
What does this MR do?
NTP
Gitaly cluster gained a dependency on NTP in 15.4 which (by default) doesn't work behind firewalls and in airgapped environments. Discussed in a related MR and it came up in a customer ticket (internal link)
It might get removed in %15.6 and / or backported - gitaly!5040 (merged) but that's in the future.
While documenting the NTP requirement for Gitaly Cluster, Geo has a soft dependency on pool.ntp.org
as well, so I'm linking to the new documentation on that topic
Replica paths
Gitaly cluster no longer uses @hashed
storage paths for new repos. This needs noting in the upgrade notes because it affects the deployment of server hooks, even though that's not documented for Gitaly Cluster (Gitaly Cluster Docs: clarify server hooks (gitaly#4202))
Gitaly cluster server hooks
Started documenting it as the Praefect replica path thing needs a mention now. Not enough to sort out Gitaly Cluster Docs: clarify server hooks (gitaly#4202)
Related issues
NTP
Replica paths / Server hooks
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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
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.