diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-05 03:09:40 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-05 03:09:40 +0300 |
commit | f9959151a9a86b7b2fc8b17721877c62040a5e4e (patch) | |
tree | 6d05f2cb8c8bc65d4bdbc74d919cf9c3974e65cc /doc | |
parent | 77f2d560b43d737700259028a8f42b70196ba621 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/documentation/testing.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/development/documentation/testing.md b/doc/development/documentation/testing.md index 4a7e206da20..31e495fe9a4 100644 --- a/doc/development/documentation/testing.md +++ b/doc/development/documentation/testing.md @@ -48,6 +48,24 @@ To run tests locally, it's important to: ### Lint checks +Merge requests containing changes to Markdown (`.md`) files run a `docs-lint markdown` +job. This job runs `markdownlint`, and a set of tests from +[`/scripts/lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/lint-doc.sh) +that look for page content problems that Vale and markdownlint cannot test for. +The job fails if any of these tests fail: + +- Curl (`curl`) commands must use long-form options (`--header`) instead of short options, like `-h`. +- Documentation pages must contain front matter indicating ownership of the page. +- Non-standard Unicode space characters (NBSP, NNBSP, ZWSP) must not be used in documentation, + because they can cause irregularities in search indexing and grepping. +- `CHANGELOG.md` must not contain duplicate versions. +- No files in the `doc/` directory may be executable. +- Use `index.md` instead of `README.md`. +- Directories and file names must use underscores instead of dashes. +- Directories and file names must be in lower case. + +#### Run lint checks locally + Lint checks are performed by the [`lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/lint-doc.sh) script and can be executed with the help of a Rake task as follows: |