Update docs for `gitaly check` command
What does this MR do and why?
The check
subcommand in the gitaly-hooks
binary has been moved to
the main gitaly
binary. This subcommand is used by GitLab admins to
verify Gitaly is able to access the interal Rail API. Since this
subcommand has been relocated the documenation was updated to reference
the correct binary.
Describe in detail what your merge request does and why.
Screenshots or screen recordings
These are strongly recommended to assist reviewers and reduce the time to merge your change.
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
assigned to @justintobler
Suggested Reviewers (beta)
The individuals below may be good candidates to participate in the review based on various factors.
You can use slash commands in comments to quickly assign
/assign_reviewer @user1
.Suggested Reviewers @marcel.amirault
,@aqualls
,@rdickenson
,@cnorris
,@gitlab-bot
If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue:
https://gitlab.com/gitlab-org/gitlab/-/issues/357923
.Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".
- A deleted user
added documentation label
1 Warning Please add a merge request subtype to this merge request. 1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/administration/gitaly/configure_gitaly.md
doc/administration/gitaly/praefect.md
doc/administration/reference_architectures/10k_users.md
doc/administration/reference_architectures/25k_users.md
doc/administration/reference_architectures/2k_users.md
doc/administration/reference_architectures/50k_users.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger- Resolved by 🤖 GitLab Bot 🤖
@justintobler - please add typebug typefeature, typemaintenance or a subtype label to this merge request.- typebug: Defects in shipped code and fixes for those defects. This includes all the bug types (availability, performance, security vulnerability, mobile, etc.)
- typefeature: Effort to deliver new features, feature changes & improvements. This includes all changes as part of new product requirements like application limits.
- typemaintenance: Up-keeping efforts & catch-up corrective improvements that are not Features nor Bugs. This includes restructuring for long-term maintainability, stability, reducing technical debt, improving the contributor experience, or upgrading dependencies.
See the handbook for more guidance on classifying.
This message was created with automation and Engineering Productivity is looking for feedback in this issue:
https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/issues/43
added typemaintenance label
mentioned in merge request gitaly!4763 (merged)
- Resolved by Evan Read
@wchandler These are the changes to the documentation for moving the subcommand. I think I got everything
Also I noticed that you cannot merge for this repository. Do you know if there someone else I should be adding to review this change?
requested review from @wchandler
Setting label groupgitaly based on
@justintobler
's group.added groupgitaly label
requested review from @eread
removed review request for @wchandler
Setting label(s) Category:Gitaly devopssystems sectionenablement based on groupgitaly.
added Category:Gitaly devopssystems sectioncore platform labels
- Resolved by Evan Read
removed review request for @eread
changed milestone to %15.3
added Technical Writing docsimprovement labels
added 332 commits
-
bb2de4d9...705e900c - 331 commits from branch
master
- 28f13e21 - Update docs for `gitaly check` command
-
bb2de4d9...705e900c - 331 commits from branch
requested review from @eread
enabled an automatic merge when the pipeline for 872e6b8f succeeds
mentioned in commit e983425f
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label