summaryrefslogtreecommitdiff
path: root/qa/README.md
diff options
context:
space:
mode:
authorMark Lapierre <mlapierre@gitlab.com>2019-06-19 00:22:23 +0000
committerMark Lapierre <mlapierre@gitlab.com>2019-06-19 00:22:23 +0000
commit09d7f0c0e0c6c7906078dbf1797b08e08d0e696c (patch)
treeb2ca3665ea8be2f47f6a7e0b1d0b1bd454c10771 /qa/README.md
parent133dc87501d003f64c7f186c3988c79bf861557d (diff)
downloadgitlab-ce-09d7f0c0e0c6c7906078dbf1797b08e08d0e696c.tar.gz
Update docs on how to run E2E testsdocs-ml-gdk-how-to-more-info
Make instructions on how to run the E2E tests against GDK more explicit and easier to find.
Diffstat (limited to 'qa/README.md')
-rw-r--r--qa/README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/qa/README.md b/qa/README.md
index ef6f202464d..124a79a36b4 100644
--- a/qa/README.md
+++ b/qa/README.md
@@ -34,8 +34,23 @@ using `package-and-qa` manual action, to test if everything works fine.
## How can I use it?
-You can use GitLab QA to exercise tests on any live instance! For example, the
-following call would login to a local [GDK] instance and run all specs in
+You can use GitLab QA to exercise tests on any live instance! If you don't
+have an instance available you can follow the instructions below to use
+the [GitLab Development Kit (GDK)][GDK].
+This is the recommended option if you would like to contribute to the tests.
+
+### Run the end-to-end tests in a local development environment
+
+Follow the GDK instructions to [prepare](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/prepare.md)
+and [install](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/set-up-gdk.md)
+your local GitLab development environment.
+
+Once you have GDK running, switch to the `qa` directory. E.g., if you setup
+GDK to develop in the main `gitlab-ce` repo, the GitLab source code will be
+in a `gitlab` directory and so the end-to-end test code will be in `gitlab/qa`.
+
+From there you can run the tests. For example, the
+following call would login to the GDK instance and run all specs in
`qa/specs/features`:
```