Improve organization of code coverage documentation
What does this MR do?
The code coverage docs are spread in areas that are not obvious to find. The MR focuses on organizing code coverage features in a single spot along with cleaning up pointers.
- Pipelines Settings Page: Removed lonely code coverage section that didn't seem to fit and placed in new "Code Coverage" page under testing directory
- Approvals Page: The code coverage rule was under "Settings" that seemed out of place. Moved to "Rules" page along with other rules. Also moved Troubleshooting section to bottom.
- Code Coverage Page (New): Curate all the related code coverage features:
- View in MR
- View project history
- View group history
- Badge
- Code Coverage Approval Rule
- CI YAML page: Reference parse examples
- Navigation update: gitlab-docs!3745 (merged)
Related issues
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.
Edited by Joe Randazzo