Post-merge review for changes to webhook page
What does this MR do?
Merge request !197850 (merged) had a difficult review process (91 comments!) and I offered to handle the docs changes in a follow-up merge request. The request for a post-merge review was moved to #570057 (closed).
The changes tidy up the edits to doc/user/project/integrations/webhook_events.md, and include:
- Alphabetizing a table, starting around line 28
- Straightening up table columns
- Some polish to the new
### System-initiated merge request eventssubheading around line 917
Related issues
- Closes Polish recent changes to webhook-triggers page (#570057 - closed)
- Related to Add webhook trigger for system-initiated approv... (!197850 - merged)
- Related to Merge request webhook when approvals are reset ... (#553070 - closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
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.