Cross-link 3 similar API features
What does this MR do?
In #390454 (closed), specifically the Other links and references subheading, @bhaalsen provided some feedback I could tackle relatively easily. (That is not to say I will have gotten the phrasing right the first time.)
- Three APIs provide endpoints related to commenting on merge requests, and those pages are not crosslinked:
- Commits API, specifically "Post comment to commit"
- Notes API, specifically "Create new merge request note"
- Discussions API, specifically "Create a new thread in the merge request diff"
- No portion of the Suggest Changes API page describes how to create a new suggestion. (Answer, in short: it's a specially formatted comment, but we should actually SAY that instead of leaving it for the user to guess.)
- Subheadings are supposed to be in present tense, and not use gerunds. On such a short page, the different subheading formats would be obvious, so I renamed the other two subheads "Applying a suggestion" and "Applying multiple suggestions" for consistency with
Create a suggestion
.
- Subheadings are supposed to be in present tense, and not use gerunds. On such a short page, the different subheading formats would be obvious, so I renamed the other two subheads "Applying a suggestion" and "Applying multiple suggestions" for consistency with
Related issues
Related to API Documentation: Create multiple batched/draf... (#390454 - closed) which contains (helpful!) user feedback from @bhaalsen
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
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.