Skip to content

Various Gitaly doc fixes and simplifications

Ben Bodenmiller requested to merge patch-102 into master

What does this MR do?

  • Formatting fixes for 6823c56b and more
  • Fix order of some things from 6823c56b
  • Finish putting everything with auth in auth section rather than over multiple sections as started in 6823c56b
  • More consistent use of Gitaly server and Gitaly client as called out in top intro
  • Less use of node
    • Called out in intro at top
  • Certificate setup clarification and simplification
  • Don't call out where to make change (Gitaly server vs client) when it's obvious based on section
  • Call out where to make change (Gitaly server vs client) when it's not obvious
  • Shorter lines to improve raw readability
  • Typo fixes

Related issues

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading