Adds documentation for e2e:test-on-gdk
What does this MR do?
Adds documentation for the e2e:test-on-gdk
pipeline.
- Adds an overview to the main End-to-end Testing doc
- Renames
package_and_test_pipeline.md
totest_pipelines.md
and adds a section for thee2e:test-on-gdk
pipeline.
Todo
-
Open another MR to update https://gitlab.com/gitlab-org/gitlab-docs/blob/main/content/_data/navigation.yaml : gitlab-docs!4155 (merged)
Read the redirect guidelines first.
-
Make sure the old link is not removed and has its contents replaced with a link to the new location. -
Make sure internal links pointing to the document in question are not broken. -
Search and replace any links referring to old docs in GitLab Rails app, specifically under the app/views/
andee/app/views
(for GitLab EE) directories. - [-]
Update the link infeatures.yml
(if applicable).
Related issues
Part of gitlab-org/quality/quality-engineering/team-tasks#1841 (closed) and gitlab-org/quality/quality-engineering&4 (closed)
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 Mark Lapierre