Skip to content

First iteration of documentation for writing end-to-end tests

Walmyr Lima e Silva Filho requested to merge docs-writing-e2e-tests into master

What does this MR do?

This is the first iteration of documentation for the GitLab QA framework that intends to make easier for every engineer to contribute with the end-to-end tests creation, edition, and improvements.

Note: there are still some things to be done, but I'll address them in a different MR, as suggested by @at.ramya.

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by the assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Walmyr Lima e Silva Filho

Merge request reports