diff options
| author | Evan Read <eread@gitlab.com> | 2018-12-07 15:27:09 +1000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2018-12-07 16:01:40 +1000 |
| commit | 180d9375524f43157cb0aa3004f0531ebe5a3c19 (patch) | |
| tree | eb7a4bb3dae0b1b03bd568bf02048ac0e2f6d8c3 /doc/development/documentation/index.md | |
| parent | b74a4161d5df1d3047a7ef81c8b5f3f1591b0424 (diff) | |
| download | gitlab-ce-180d9375524f43157cb0aa3004f0531ebe5a3c19.tar.gz | |
Provide information on /help rspec tests
Diffstat (limited to 'doc/development/documentation/index.md')
| -rw-r--r-- | doc/development/documentation/index.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index b7990e1b558..55aed023325 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -368,6 +368,16 @@ You can combine one or more of the following: = link_to 'Help page', help_page_path('user/permissions') ``` +### GitLab `/help` tests + +Several [rspec tests](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/spec/features/help_pages_spec.rb) +are run to ensure GitLab documentation renders and works correctly. In particular, that [main docs landing page](../../README.md) will work correctly from `/help`. +For example, [GitLab.com's `/help`](https://gitlab.com/help). + +CAUTION: **Caution:** +Because the rspec tests only run in a full pipeline, and not a special [docs-only pipeline](#branch-naming), it is possible +to merge changes that will break `master` from a merge request with a successful docs-only pipeline run. + ## General Documentation vs Technical Articles ### General documentation @@ -552,6 +562,7 @@ Currently, the following tests are in place: As CE is merged into EE once a day, it's important to avoid merge conflicts. Submitting an EE-equivalent merge request cherry-picking all commits from CE to EE is essential to avoid them. +1. In a full pipeline, tests for [`/help`](#gitlab-help-tests). ### Linting |