Improve architecture of docs relating to Pipeline Insights
Problem to solve
As pointed out in #287664 (comment 636579858), the unit test doc was filling up with numerous examples. These examples should be split out into their own page.
While researching this, I realized that the general architecture of all the ~"group::pipeline insights" docs could be improved.
Proposal
Some initial MVC ideas:
-
Create a
doc/ci/testing
directory for docs relating to tests in GitLab CI/CD. -
Move the
doc/ci/unit_test_reports.md
into that directory (along with the images). -
Split the examples out of the above doc into a new page
doc/ci/testing/unit_test_report_examples.md
-
This new directory should have an
index.md
as well. I found the perfect page for this: https://docs.gitlab.com/ee/user/project/merge_requests/testing_and_reports_in_merge_requests.html#tests-and-reports-in-merge-requestsThis page is not in the global nav at all, but is suitable as an
index.md
for this new directory, so we should move it there.
Followup steps
We should move other testing docs here. If they run in CI/CD, and need to be configured in the pipeline config file, I think it makes sense for them to be in doc/ci/testing
. This includes Load performance testing, Browser performance testing, accessibility testing, fail fast testing, etc... These are mostly located in doc/user/project/merge_requests
, which might not be the best place for them. While the reports can be configured to show up in the MR, the key point is that we're running tests in CI/CD.
-
Accessibility Testing - !90762 (merged) -
Browser Performance Testing - !90762 (merged) -
Code Quality - !90762 (merged) -
Fail fast testing - !90789 (merged) -
Load Performance Testing - !90789 (merged) -
Metrics Reports - !90789 (merged) -
Test Coverage visualization - !90789 (merged)
Finally, Nav update to match: gitlab-docs!2848 (merged)