Skip to content

Update documentation to match Gitaly's new configuration structure

Sami Hiltunen requested to merge smh-update-gitaly-config-structure into master

What does this MR do?

Omnibus previously had a custom configuration structure for Gitaly that didn't match the actual structure of Gitaly. This made a number of things more difficult than they had to be. Omnibus was recently updated to place Gitaly's configuration under gitaly['configuration'] hash which gets directly marshaled as TOML for the final Gitaly configuration. While there is still backwards compatibility handling in place, we should update the documentation to use the new structure in preparation for deprecating the old configuration keys. This commit updates Gitaly's documentation to refer to the new keys.

Related issues

gitaly#4467 (closed)
gitaly#4754 (closed)
omnibus-gitlab!6621 (merged)

Author's checklist

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 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 reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports

Loading