What does this MR do?
Specifying that we don't need to spell out AI. Following this guidance from Microsoft: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/ai-bot-terms
Optional. Consider taking the GitLab Technical Writing Fundamentals course.
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:
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
These labels cause the MR to be added to code verification QA issues.
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
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.