Skip to content
Snippets Groups Projects

Update documentation to match Gitaly's new configuration structure

Merged Sami Hiltunen requested to merge smh-update-gitaly-config-structure into master
All threads resolved!

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
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Evan Read
  • Evan Read
  • Evan Read
  • Evan Read
  • Evan Read
  • Evan Read removed review request for @eread

    removed review request for @eread

  • Sami Hiltunen added 1 commit

    added 1 commit

    • 76de04da - Apply 3 suggestion(s) to 1 file(s)

    Compare with previous version

  • Sami Hiltunen added 1 commit

    added 1 commit

    • 09177d09 - Apply 2 suggestion(s) to 2 file(s)

    Compare with previous version

  • Sami Hiltunen added 4 commits

    added 4 commits

    • ce138d7f - Add migration instructions for Praefect's new configuration
    • 5205168d - Document invalid metadata deletions being default enabled
    • 71167a04 - Update documentation to match Gitaly's new configuration structure
    • 53c56407 - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Sami Hiltunen added 5 commits

    added 5 commits

    • f53f5017 - Update documentation to match Praefect's new configuration structure
    • 4e2b9002 - Add migration instructions for Praefect's new configuration
    • bc85b67d - Document invalid metadata deletions being default enabled
    • b140ac6c - Update documentation to match Gitaly's new configuration structure
    • 89842037 - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Evan Read requested review from @eread

    requested review from @eread

  • Evan Read mentioned in merge request !110661 (merged)

    mentioned in merge request !110661 (merged)

  • Evan Read approved this merge request

    approved this merge request

  • Evan Read removed review request for @eread

    removed review request for @eread

  • Sami Hiltunen added 2 commits

    added 2 commits

    • 3db22d3b - Update documentation to match Gitaly's new configuration structure
    • fe39a4bd - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • mentioned in merge request omnibus-gitlab!6658 (merged)

  • Sami Hiltunen added 1885 commits

    added 1885 commits

    • fe39a4bd...15b151dc - 1883 commits from branch master
    • 6d81c8b4 - Update documentation to match Gitaly's new configuration structure
    • 0e9b15ae - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Toon Claes approved this merge request

    approved this merge request

  • Evan Read requested review from @eread

    requested review from @eread

  • Evan Read resolved all threads

    resolved all threads

  • Evan Read resolved all threads

    resolved all threads

  • Evan Read approved this merge request

    approved this merge request

  • Evan Read removed review request for @eread

    removed review request for @eread

  • 🤖 GitLab Bot 🤖 changed milestone to %15.10

    changed milestone to %15.10

  • mentioned in merge request omnibus-gitlab!6621 (merged)

  • Sami Hiltunen added 991 commits

    added 991 commits

    • 0e9b15ae...98bb24cb - 989 commits from branch master
    • 41793059 - Update documentation to match Gitaly's new configuration structure
    • 2aed864f - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Toon Claes removed review request for @toon

    removed review request for @toon

  • Evan Read mentioned in merge request !113286 (merged)

    mentioned in merge request !113286 (merged)

  • Evan Read mentioned in merge request !113847 (merged)

    mentioned in merge request !113847 (merged)

  • Sami Hiltunen added 2528 commits

    added 2528 commits

    • 2aed864f...0c0ef58b - 2526 commits from branch master
    • 7b691b72 - Update documentation to match Gitaly's new configuration structure
    • 2ed5497d - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Evan Read approved this merge request

    approved this merge request

  • Evan Read resolved all threads

    resolved all threads

  • Sami Hiltunen added 553 commits

    added 553 commits

    • 2ed5497d...d3fe24b9 - 551 commits from branch master
    • 9744919d - Update documentation to match Gitaly's new configuration structure
    • af6fb0ad - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Sami Hiltunen added 1 commit

    added 1 commit

    • c48cfccc - Add migration instructions for Gitaly's new configuration

    Compare with previous version

  • Evan Read requested review from @eread

    requested review from @eread

  • Evan Read approved this merge request

    approved this merge request

  • Evan Read resolved all threads

    resolved all threads

  • Evan Read enabled an automatic merge when the pipeline for 26c08556 succeeds

    enabled an automatic merge when the pipeline for 26c08556 succeeds

  • merged

  • Evan Read mentioned in commit 4f5ead81

    mentioned in commit 4f5ead81

  • added workflowstaging label and removed workflowcanary label

  • mentioned in issue gitaly#4754 (closed)

  • Please register or sign in to reply
    Loading