diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-06 09:09:17 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-06 09:09:17 +0000 |
commit | eaea945e0355826c58c3dcf887496ea91064f85c (patch) | |
tree | 0f20e03304d35e68375e99a606b9b94483e37ee5 /doc/development | |
parent | cce8cf03d3bebe8b05375e4db0004328f84b28a2 (diff) | |
download | gitlab-ce-eaea945e0355826c58c3dcf887496ea91064f85c.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/code_review.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/index.md | 54 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 2 |
3 files changed, 7 insertions, 51 deletions
diff --git a/doc/development/code_review.md b/doc/development/code_review.md index efc9cad9810..c480db54705 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -468,7 +468,7 @@ helped us with overall code quality (using delegation, `&.` those types of things), and making the code more robust. **["Support multiple assignees for merge requests"](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/10161)**: -A good example of collaboration on an MR touching multiple parts of the codebase. Nick pointed out interesting edge cases, James Lopes also joined in raising concerns on import/export feature. +A good example of collaboration on an MR touching multiple parts of the codebase. Nick pointed out interesting edge cases, James Lopez also joined in raising concerns on import/export feature. ### Credits diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 21e94a3464e..f016022576b 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -410,7 +410,7 @@ merge request with new or changed docs is submitted, are: - If any code or the `doc/README.md` file is changed, a full pipeline will run, which runs tests for [`/help`](#gitlab-help-tests). -### Running tests & lint checks locally +### Running tests Apart from [previewing your changes locally](#previewing-the-changes-live), you can also run all lint checks and Nanoc tests locally. @@ -462,62 +462,20 @@ The output should be similar to: Note that this requires you to either have the required lint tools installed on your machine, or a working Docker installation, in which case an image with these tools pre-installed will be used. -For more information on available linters refer to the [linting](#linting) section. - -### Linting +### Local linting To help adhere to the [documentation style guidelines](styleguide.md), and improve the content added to documentation, consider locally installing and running documentation linters. This will help you catch common issues before raising merge requests for review of documentation. -The following are some suggested linters you can install locally and sample configuration: +Running the following locally allows you to match the checks in the build pipeline: -- [`proselint`](#proselint) -- [markdownlint](#markdownlint), which is the same as the test run in [`docs-lint`](#testing) -- [Vale](#vale), for English language grammar and syntax suggestions +- [markdownlint](#markdownlint). +- [Vale](#vale). NOTE: **Note:** This list does not limit what other linters you can add to your local documentation writing toolchain. -#### `proselint` - -`proselint` checks for common problems with English prose. It provides a - [plethora of checks](http://proselint.com/checks/) that are helpful for technical writing. - -`proselint` can be used [on the command line](http://proselint.com/utility/), either on a single - Markdown file or on all Markdown files in a project. For example, to run `proselint` on all - documentation in the [`gitlab` project](https://gitlab.com/gitlab-org/gitlab), run the - following commands from within the `gitlab` project: - -```shell -cd doc -proselint **/*.md -``` - -`proselint` can also be run from within editors using plugins. For example, the following plugins - are available: - -- [Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-proselint) -- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=PatrykPeszko.vscode-proselint) -- [Others](https://github.com/amperser/proselint#plugins-for-other-software) - -##### Sample `proselint` configuration - -All of the checks are good to use. However, excluding the `typography.symbols` and `misc.phrasal_adjectives` checks will reduce -noise. The following sample `proselint` configuration disables these checks: - -```json -{ - "checks": { - "typography.symbols": false, - "misc.phrasal_adjectives": false - } -} -``` - -A file with `proselint` configuration must be placed in a -[valid location](https://github.com/amperser/proselint#checks). For example, `~/.config/proselint/config`. - #### markdownlint [markdownlint](https://github.com/DavidAnson/markdownlint) checks that Markdown @@ -596,8 +554,6 @@ You can also [configure the text editor of your choice](https://errata-ai.github.io/vale/#local-use-by-a-single-writer) to display the results. -Vale's test results are not currently displayed in CI, but may be displayed in the future. - ## Danger Bot GitLab uses [Danger](https://github.com/danger/danger) for some elements in diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 8f58eb62fdd..75e38c3a5be 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -8,7 +8,7 @@ This document defines the standards for GitLab's documentation content and files For broader information about the documentation, see the [Documentation guidelines](index.md). -For programmatic help adhering to the guidelines, see [linting](index.md#linting). +For programmatic help adhering to the guidelines, see [Testing](index.md#testing). See the GitLab handbook for further [writing style guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines) that apply to all GitLab content, not just documentation. |