diff options
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/documentation/styleguide.md | 7 | ||||
| -rw-r--r-- | doc/development/testing_guide/end_to_end_tests.md | 9 |
2 files changed, 9 insertions, 7 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index c0386290785..0c51d3832aa 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -80,10 +80,11 @@ yield a useful result, and ensuring content is helpful and easy to consume. ## Text -- Splitting long lines (preferably up to 100 characters) can make it easier to provide feedback on small chunks of text. -- Insert an empty line for new paragraphs. +- Split up long lines (wrap text), this makes it much easier to review and edit. Only + double line breaks are shown as a full line break by creating new paragraphs. + 80-100 characters is the recommended line length. - Use sentence case for titles, headings, labels, menu items, and buttons. -- Insert an empty line between different markups (e.g., after every paragraph, header, list, etc). Example: +- Jump a line between different markups (e.g., after every paragraph, header, list, etc). Example: ```md ## Header diff --git a/doc/development/testing_guide/end_to_end_tests.md b/doc/development/testing_guide/end_to_end_tests.md index daa0714aec3..a239dc84a1c 100644 --- a/doc/development/testing_guide/end_to_end_tests.md +++ b/doc/development/testing_guide/end_to_end_tests.md @@ -25,10 +25,10 @@ You can find these nightly pipelines at [gitlab-org/quality/staging/pipelines][q ### Testing code in merge requests -It is possible to run end-to-end tests for a merge request, eventually being run in -a pipeline in the [`gitlab-qa`](https://gitlab.com/gitlab-org/gitlab-qa/) project, -by triggering the `package-and-qa` manual action in the `test` stage (which should -be present in a merge request widget, unless the merge request comes from a fork). +It is possible to run end-to-end tests (eventually being run within a +[GitLab QA pipeline][gitlab-qa-pipelines]) for a merge request by triggering +the `package-and-qa` manual action in the `test` stage, that should be present +in a merge request widget (unless the merge request is from a fork). Manual action that starts end-to-end tests is also available in merge requests in [Omnibus GitLab][omnibus-gitlab]. @@ -81,6 +81,7 @@ you can find an issue you would like to work on in [omnibus-gitlab]: https://gitlab.com/gitlab-org/omnibus-gitlab [gitlab-qa]: https://gitlab.com/gitlab-org/gitlab-qa [gitlab-qa-readme]: https://gitlab.com/gitlab-org/gitlab-qa/tree/master/README.md +[gitlab-qa-pipelines]: https://gitlab.com/gitlab-org/gitlab-qa/pipelines [quality-nightly-pipelines]: https://gitlab.com/gitlab-org/quality/nightly/pipelines [quality-staging-pipelines]: https://gitlab.com/gitlab-org/quality/staging/pipelines [gitlab-qa-architecture]: https://gitlab.com/gitlab-org/gitlab-qa/blob/master/docs/architecture.md |