diff options
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/feature-change-workflow.md | 3 | ||||
| -rw-r--r-- | doc/development/documentation/feature_flags.md | 10 | ||||
| -rw-r--r-- | doc/development/documentation/improvement-workflow.md | 3 | ||||
| -rw-r--r-- | doc/development/documentation/index.md | 172 | ||||
| -rw-r--r-- | doc/development/documentation/restful_api_styleguide.md | 6 | ||||
| -rw-r--r-- | doc/development/documentation/site_architecture/deployment_process.md | 8 | ||||
| -rw-r--r-- | doc/development/documentation/site_architecture/global_nav.md | 16 | ||||
| -rw-r--r-- | doc/development/documentation/site_architecture/index.md | 21 | ||||
| -rw-r--r-- | doc/development/documentation/site_architecture/release_process.md | 36 | ||||
| -rw-r--r-- | doc/development/documentation/structure.md | 8 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide/img/tier_badge.png | bin | 0 -> 9592 bytes | |||
| -rw-r--r-- | doc/development/documentation/styleguide/index.md | 774 | ||||
| -rw-r--r-- | doc/development/documentation/testing.md | 130 | ||||
| -rw-r--r-- | doc/development/documentation/workflow.md | 16 |
14 files changed, 582 insertions, 621 deletions
diff --git a/doc/development/documentation/feature-change-workflow.md b/doc/development/documentation/feature-change-workflow.md index 004d8833e63..78e5510ffca 100644 --- a/doc/development/documentation/feature-change-workflow.md +++ b/doc/development/documentation/feature-change-workflow.md @@ -3,3 +3,6 @@ redirect_to: 'workflow.md' --- This document was moved to [another location](workflow.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/development/documentation/feature_flags.md b/doc/development/documentation/feature_flags.md index 5bc3e1d59e2..59298c5345f 100644 --- a/doc/development/documentation/feature_flags.md +++ b/doc/development/documentation/feature_flags.md @@ -30,7 +30,7 @@ See how to document them below, according to the state of the flag: - [Features that can be enabled or disabled for a single project](#features-enabled-by-project). - [Features with the feature flag removed](#features-with-flag-removed). -The [`**(CORE ONLY)**`](styleguide/index.md#product-badges) badge or equivalent for +The [`**(CORE ONLY)**`](styleguide/index.md#product-tier-badges) badge or equivalent for the feature's tier should be added to the line and heading that refers to enabling/disabling feature flags as Admin access is required to do so, therefore, it indicates that it cannot be done by regular users of GitLab.com. @@ -65,7 +65,7 @@ be enabled for a single project, and is not ready for production use: > - It's not recommended for production use. > - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#anchor-to-section). **(CORE ONLY)** -CAUTION: **Warning:** +WARNING: This feature might not be available to you. Check the **version history** note above for details. (...Regular content goes here...) @@ -124,7 +124,7 @@ use: > - It's recommended for production use. > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** -CAUTION: **Warning:** +WARNING: This feature might not be available to you. Check the **version history** note above for details. (...Regular content goes here...) @@ -180,7 +180,7 @@ cannot be enabled for a single project, and is ready for production use: > - It's recommended for production use. > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** -CAUTION: **Warning:** +WARNING: This feature might not be available to you. Check the **version history** note above for details. (...Regular content goes here...) @@ -253,7 +253,7 @@ be enabled by project, and is ready for production use: > - It's recommended for production use. > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** -CAUTION: **Warning:** +WARNING: This feature might not be available to you. Check the **version history** note above for details. (...Regular content goes here...) diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index 004d8833e63..78e5510ffca 100644 --- a/doc/development/documentation/improvement-workflow.md +++ b/doc/development/documentation/improvement-workflow.md @@ -3,3 +3,6 @@ redirect_to: 'workflow.md' --- This document was moved to [another location](workflow.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 69a8ff10878..5fb5e9b433a 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -1,13 +1,13 @@ --- stage: none group: Documentation Guidelines -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: Learn how to contribute to GitLab Documentation. --- # GitLab Documentation guidelines -GitLab's documentation is [intended as the single source of truth (SSOT)](https://about.gitlab.com/handbook/documentation/) for information about how to configure, use, and troubleshoot GitLab. The documentation contains use cases and usage instructions for every GitLab feature, organized by product area and subject. This includes topics and workflows that span multiple GitLab features, and the use of GitLab with other applications. +The GitLab documentation is [intended as the single source of truth (SSOT)](https://about.gitlab.com/handbook/documentation/) for information about how to configure, use, and troubleshoot GitLab. The documentation contains use cases and usage instructions for every GitLab feature, organized by product area and subject. This includes topics and workflows that span multiple GitLab features, and the use of GitLab with other applications. In addition to this page, the following resources can help you craft and contribute to documentation: @@ -38,8 +38,8 @@ Documentation issues and merge requests are part of their respective repositorie The [CI pipeline for the main GitLab project](../pipelines.md) is configured to automatically run only the jobs that match the type of contribution. If your contribution contains -**only** documentation changes, then only documentation-related jobs will be run, and -the pipeline will complete much faster than a code contribution. +**only** documentation changes, then only documentation-related jobs run, and +the pipeline completes much faster than a code contribution. If you are submitting documentation-only changes to Runner, Omnibus, or Charts, the fast pipeline is not determined automatically. Instead, create branches for @@ -82,7 +82,7 @@ All values are treated as strings and are only used for the Each page should ideally have metadata related to the stage and group it belongs to, as well as an information block as described below: -- `stage`: The [Stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages) +- `stage`: The [Stage](https://about.gitlab.com/handbook/product/categories/#devops-stages) to which the majority of the page's content belongs. - `group`: The [Group](https://about.gitlab.com/company/team/structure/#product-groups) to which the majority of the page's content belongs. @@ -93,7 +93,7 @@ belongs to, as well as an information block as described below: ```plaintext To determine the technical writer assigned to the Stage/Group associated with this page, see - https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers + https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments ``` For example, the following metadata would be at the beginning of a product @@ -104,7 +104,7 @@ feature: --- stage: Monitor group: APM -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- ``` @@ -152,7 +152,7 @@ comments: false Each page can have additional, optional metadata (set in the [default.html](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/fc3577921343173d589dfa43d837b4307e4e620f/layouts/default.html#L30-52) -Nanoc layout), which will be displayed at the top of the page if defined: +Nanoc layout), which is displayed at the top of the page if defined: - `reading_time`: If you want to add an indication of the approximate reading time of a page, you can set `reading_time` to `true`. This uses a simple @@ -161,78 +161,82 @@ Nanoc layout), which will be displayed at the top of the page if defined: ## Move or rename a page -Moving or renaming a document is the same as changing its location. This process -requires specific steps to ensure that visitors can find the new -documentation page, whether they're using `/help` from a GitLab instance or by -visiting <https://docs.gitlab.com>. - -Be sure to assign a technical writer to a page move or rename MR. Technical +Moving or renaming a document is the same as changing its location. +Be sure to assign a technical writer to any MR that renames or moves a page. Technical Writers can help with any questions and can review your change. -To change a document's location, don't remove the old document, but instead -replace all of its content with the following: +When moving or renaming a page, you must redirect browsers to the new page. This +ensures users find the new page, and have the opportunity to update their bookmarks. -```markdown ---- -redirect_to: '../path/to/file/index.md' ---- +There are two types of redirects: -This document was moved to [another location](../path/to/file/index.md). -``` +- Redirect files added into the docs themselves, for users who view the docs in `/help` + on self-managed instances. For example, [`/help` on GitLab.com](https://gitlab.com/help). +- Redirects in a [`_redirects`](../../user/project/pages/redirects.md) file, for users + who view the docs on <http://docs.gitlab.com>. -Replace `../path/to/file/index.md` with the relative path to the old document. +To add a redirect: -The `redirect_to` variable supports both full and relative URLs; for example: +1. In an MR in one of the internal docs projects (`gitlab`, `gitlab-runner`, `omnibus-gitlab` + or `charts`): + 1. Move or rename the doc, but do not delete the old doc. + 1. In the old doc, add the redirect code for `/help`. Use the following template exactly, + and only change the links and date. Use relative paths and `.md` for a redirect + to another docs page. Use the full URL to redirect to a different project or site: -- `https://docs.gitlab.com/ee/path/to/file.html` -- `../path/to/file.html` -- `path/to/file.md` + ```markdown + --- + redirect_to: '../path/to/file/index.md' + --- -The redirect works for <https://docs.gitlab.com>, and any `*.md` paths are -changed to `*.html`. The description line following the `redirect_to` code -informs the visitor that the document changed location if the redirect process -doesn't complete successfully. + This document was moved to [another location](../path/to/file/index.md). -For example, if you move `doc/workflow/lfs/index.md` to -`doc/administration/lfs.md`, then the steps would be: + <!-- This redirect file can be deleted after <YYYY-MM-DD>. --> + <!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> + ``` -1. Copy `doc/workflow/lfs/index.md` to `doc/administration/lfs.md` -1. Replace the contents of `doc/workflow/lfs/index.md` with: + Redirect files linking to docs in any of the 4 internal docs projects can be + removed after 3 months. Redirect files linking to external sites can be removed + after 1 year. - ```markdown - --- - redirect_to: '../../administration/lfs.md' - --- + 1. If the document being moved has any Disqus comments on it, follow the steps + described in [Redirections for pages with Disqus comments](#redirections-for-pages-with-disqus-comments). + 1. Assign the MR to a technical writer for review and merge. +1. If the redirect is to one of the 4 internal docs projects (not an external URL), + create an MR in [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs): + 1. Update [`_redirects`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/content/_redirects) + with one redirect entry for each renamed or moved file. This code works for + <https://docs.gitlab.com> links only: - This document was moved to [another location](../../administration/lfs.md). - ``` + ```plaintext + /ee/path/to/old_file.html /ee/path/to/new_file 302 # To be removed after YYYY-MM-DD + ``` -1. Find and replace any occurrences of the old location with the new one. - A quick way to find them is to use `git grep` on the repository you changed - the file from: + The path must start with the internal project directory `/ee` for `gitlab`, + `/gitlab-runner`, `/omnibus-gitlab` or `charts`, and must end with `.html`. - ```shell - git grep -n "workflow/lfs/lfs_administration" - git grep -n "lfs/lfs_administration" - ``` + `_redirects` entries can be removed after one year. -1. If the document being moved has any Disqus comments on it, follow the steps - described in [Redirections for pages with Disqus comments](#redirections-for-pages-with-disqus-comments). +1. Search for links to the old file. You must find and update all links to the old file: -Things to note: + - In <https://gitlab.com/gitlab-com/www-gitlab-com>, search for full URLs: + `grep -r "docs.gitlab.com/ee/path/to/file.html" .` + - In <https://gitlab.com/gitlab-org/gitlab-docs/-/tree/master/content/_data>, + search the navigation bar configuration files for the path with `.html`: + `grep -r "path/to/file.html" .` + - In any of the 4 internal projects. This includes searching for links in the docs + and codebase. Search for all variations, including full URL and just the path. + In macOS for example, go to the root directory of the `gitlab` project and run: -- Since we also use inline documentation, except for the documentation itself, - the document might also be referenced in the views of GitLab (`app/`) which will - render when visiting `/help`, and sometimes in the testing suite (`spec/`). - You must search these paths for references to the doc and update them as well. -- The above `git grep` command will search recursively in the directory you run - it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration` - and will print the file and the line where this file is mentioned. - You may ask why the two greps. Since [we use relative paths to link to - documentation](styleguide/index.md#links), sometimes it might be useful to search a path deeper. -- The `*.md` extension is not used when a document is linked to GitLab's - built-in help page, which is why we omit it in `git grep`. -- Use the checklist on the "Change documentation location" MR description template. + ```shell + grep -r "docs.gitlab.com/ee/path/to/file.html" . + grep -r "path/to/file.html" . + grep -r "path/to/file.md" . + grep -r "path/to/file" . + ``` + + You may need to try variations of relative links as well, such as `../path/to/file` + or even `../file` to find every case. ### Redirections for pages with Disqus comments @@ -249,7 +253,7 @@ available under `https://docs.gitlab.com/my-old-location/README.html` to a new l `https://docs.gitlab.com/my-new-location/index.html`. Into the **new document** front matter, we add the following information. You must -include the file name in the `disqus_identifier` URL, even if it's `index.html` or `README.html`. +include the filename in the `disqus_identifier` URL, even if it's `index.html` or `README.html`. ```yaml --- @@ -267,7 +271,7 @@ Before getting started, make sure you read the introductory section - Label the MR `Documentation` (can only be done by people with `developer` access, for example, GitLab team members) - Assign the correct milestone per note below (can only be done by people with `developer` access, for example, GitLab team members) -Documentation will be merged if it is an improvement on existing content, +Documentation is merged if it is an improvement on existing content, represents a good-faith effort to follow the template and style standards, and is believed to be accurate. @@ -285,16 +289,16 @@ Every GitLab instance includes the documentation, which is available at `/help` (`https://gitlab.example.com/help`). For example, <https://gitlab.com/help>. The documentation available online on <https://docs.gitlab.com> is deployed every four hours from the `master` branch of GitLab, Omnibus, and Runner. Therefore, -after a merge request gets merged, it will be available online on the same day. -However, it will be shipped (and available on `/help`) within the milestone assigned +after a merge request gets merged, it is available online on the same day. +However, it's shipped (and available on `/help`) within the milestone assigned to the MR. For example, let's say your merge request has a milestone set to 11.3, which -will be released on 2018-09-22. If it gets merged on 2018-09-15, it will be +a release date of 2018-09-22. If it gets merged on 2018-09-15, it is available online on 2018-09-15, but, as the feature freeze date has passed, if the MR does not have a `~"Pick into 11.3"` label, the milestone has to be changed -to 11.4 and it will be shipped with all GitLab packages only on 2018-10-22, -with GitLab 11.4. Meaning, it will only be available under `/help` from GitLab +to 11.4 and it ships with all GitLab packages only on 2018-10-22, +with GitLab 11.4. Meaning, it's available only with `/help` from GitLab 11.4 onward, but available on <https://docs.gitlab.com/> on the same day it was merged. ### Linking to `/help` @@ -365,7 +369,7 @@ You can combine one or more of the following: ### GitLab `/help` tests Several [RSpec tests](https://gitlab.com/gitlab-org/gitlab/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`. +are run to ensure GitLab documentation renders and works correctly. In particular, that [main docs landing page](../../README.md) works correctly from `/help`. For example, [GitLab.com's `/help`](https://gitlab.com/help). ## Docs site architecture @@ -381,7 +385,7 @@ on how the left-side navigation menu is built and updated. ## Previewing the changes live -NOTE: **Note:** +NOTE: To preview your changes to documentation locally, follow this [development guide](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md#development-when-contributing-to-gitlab-documentation) or [these instructions for GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md). @@ -392,20 +396,20 @@ The live preview is currently enabled for the following projects: If your merge request has docs changes, you can use the manual `review-docs-deploy` job to deploy the docs review app for your merge request. -You will need at least Maintainer permissions to be able to run it. +You need at least Maintainer permissions to be able to run it.  You must push a branch to those repositories, as it doesn't work for forks. -The `review-docs-deploy*` job will: +The `review-docs-deploy*` job: -1. Create a new branch in the [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) +1. Creates a new branch in the [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) project named after the scheme: `docs-preview-$DOCS_GITLAB_REPO_SUFFIX-$CI_MERGE_REQUEST_IID`, where `DOCS_GITLAB_REPO_SUFFIX` is the suffix for each product, e.g, `ee` for EE, `omnibus` for Omnibus GitLab, etc, and `CI_MERGE_REQUEST_IID` is the ID of the respective merge request. -1. Trigger a cross project pipeline and build the docs site with your changes. +1. Triggers a cross project pipeline and build the docs site with your changes. In case the review app URL returns 404, this means that either the site is not yet deployed, or something went wrong with the remote pipeline. Give it a few @@ -414,11 +418,11 @@ remote pipeline from the link in the merge request's job output. If the pipeline failed or got stuck, drop a line in the `#docs` chat channel. Make sure that you always delete the branch of the merge request you were -working on. If you don't, the remote docs branch won't be removed either, -and the server where the Review Apps are hosted will eventually be out of +working on. If you don't, the remote docs branch isn't removed either, +and the server where the Review Apps are hosted can eventually run out of disk space. -TIP: **Tip:** +NOTE: Someone with no merge rights to the GitLab projects (think of forks from contributors) cannot run the manual job. In that case, you can ask someone from the GitLab team who has the permissions to do that for you. @@ -449,7 +453,7 @@ If you want to know the in-depth details, here's what's really happening: - The number of the merge request is added so that you can know by the `gitlab-docs` branch name the merge request it originated from. 1. The remote branch is then created if it doesn't exist (meaning you can - re-run the manual job as many times as you want and this step will be skipped). + re-run the manual job as many times as you want and this step is skipped). 1. A new cross-project pipeline is triggered in the docs project. 1. The preview URL is shown both at the job output and in the merge request widget. You also get the link to the remote pipeline. @@ -494,7 +498,7 @@ To run the tool on an existing screenshot generator, take the following steps: 1. Set up the [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md). 1. Navigate to the subdirectory with your cloned GitLab repository, typically `gdk/gitlab`. 1. Make sure that your GDK database is fully migrated: `bin/rake db:migrate RAILS_ENV=development`. -1. Install pngquant, see the tool website for more info: [`pngquant`](https://pngquant.org/) +1. Install pngquant, see the tool website for more information: [`pngquant`](https://pngquant.org/) 1. Run `scripts/docs_screenshots.rb spec/docs_screenshots/<name_of_screenshot_generator>.rb <milestone-version>`. 1. Identify the location of the screenshots, based on the `gitlab/doc` location defined by the `it` parameter in your script. 1. Commit the newly created screenshots. @@ -537,8 +541,12 @@ To have the screenshot focuses few more steps are needed: - **wait for the content**: `expect(screenshot_area).to have_content 'Expiration interval'` - **set the crop area**: `set_crop_data(screenshot_area, 20)` -In particular `set_crop_data` accepts as arguments: a `DOM` element and a padding, the padding will be added around the element enlarging the screenshot area. +In particular, `set_crop_data` accepts as arguments: a `DOM` element and a +padding. The padding is added around the element, enlarging the screenshot area. #### Live example Please use `spec/docs_screenshots/container_registry_docs.rb` as a guide and as an example to create your own scripts. + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/development/documentation/restful_api_styleguide.md b/doc/development/documentation/restful_api_styleguide.md index 13c6140114f..c8c48e71b48 100644 --- a/doc/development/documentation/restful_api_styleguide.md +++ b/doc/development/documentation/restful_api_styleguide.md @@ -3,7 +3,7 @@ type: reference, dev stage: none group: Development info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines" -description: "Writing styles, markup, formatting, and other standards for GitLab's RESTful APIs." +description: "Writing styles, markup, formatting, and other standards for the GitLab RESTful APIs." --- # RESTful API @@ -107,10 +107,10 @@ Rendered example: ## cURL Examples -The following sections include a set of [cURL](https://curl.haxx.se) examples +The following sections include a set of [cURL](https://curl.se/) examples you can use in the API documentation. -CAUTION: **Caution:** +WARNING: Do not use information for real users, URLs, or tokens. For documentation, refer to our relevant style guide sections on [Fake user information](styleguide/index.md#fake-user-information), [Fake URLs](styleguide/index.md#fake-urls), and [Fake tokens](styleguide/index.md#fake-tokens). diff --git a/doc/development/documentation/site_architecture/deployment_process.md b/doc/development/documentation/site_architecture/deployment_process.md index f101a669968..d92f58e5501 100644 --- a/doc/development/documentation/site_architecture/deployment_process.md +++ b/doc/development/documentation/site_architecture/deployment_process.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Documentation deployment process @@ -36,7 +36,7 @@ and tag all tooling images locally: ``` For each image, there's a manual job under the `images` stage in -[`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/.gitlab-ci.yml) which can be invoked at will. +[`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/.gitlab-ci.yml) which can be invoked at any time. ## Update an old Docker image with new upstream docs content @@ -46,12 +46,12 @@ for the version in question. ## Porting new website changes to old versions -CAUTION: **Warning:** +WARNING: Porting changes to older branches can have unintended effects as we're constantly changing the backend of the website. Use only when you know what you're doing and make sure to test locally. -The website will keep changing and being improved. In order to consolidate +The website keeps changing and being improved. In order to consolidate those changes to the stable branches, we'd need to pick certain changes from time to time. diff --git a/doc/development/documentation/site_architecture/global_nav.md b/doc/development/documentation/site_architecture/global_nav.md index 21b0c4b6b43..fcf4662502f 100644 --- a/doc/development/documentation/site_architecture/global_nav.md +++ b/doc/development/documentation/site_architecture/global_nav.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: "Learn how GitLab docs' global navigation works and how to add new items." --- @@ -101,11 +101,11 @@ The global nav has 3 components: The available sections are described on the table below: -| Section | Description | -| ------------- | ------------------------------------------ | -| User | Documentation for the GitLab's user UI. | -| Administrator | Documentation for the GitLab's Admin Area. | -| Contributor | Documentation for developing GitLab. | +| Section | Description | +| ------------- | ------------------------------------ | +| User | Documentation for the GitLab UI. | +| Administrator | Documentation for the Admin Area. | +| Contributor | Documentation for developing GitLab. | The majority of the links available on the nav were added according to the UI. The match is not perfect, as for some UI nav items the documentation doesn't @@ -250,7 +250,7 @@ below the doc link: ``` All nav links are clickable. If the higher-level link does not have a link -of its own, it must link to its first sub-item link, mimicking GitLab's navigation. +of its own, it must link to its first sub-item link, mimicking the navigation in GitLab. This must be avoided so that we don't have duplicated links nor two `.active` links at the same time. @@ -292,7 +292,7 @@ and the following syntax rules. an "information" icon on the nav to make the user aware that the feature is EE-only. -CAUTION: **Caution:** +WARNING: All links present on the data file must end in `.html`, not `.md`. Do not start any relative link with a forward slash `/`. diff --git a/doc/development/documentation/site_architecture/index.md b/doc/development/documentation/site_architecture/index.md index 3772746e25b..be25a083948 100644 --- a/doc/development/documentation/site_architecture/index.md +++ b/doc/development/documentation/site_architecture/index.md @@ -1,8 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers -description: "Learn how GitLab's documentation website is architectured." +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Documentation site architecture @@ -14,8 +13,8 @@ static site generator. ## Architecture -While the source of the documentation content is stored in GitLab's respective product -repositories, the source that is used to build the documentation +While the source of the documentation content is stored in the repositories for +each GitLab product, the source that is used to build the documentation site _from that content_ is located at <https://gitlab.com/gitlab-org/gitlab-docs>. The following diagram illustrates the relationship between the repositories @@ -46,7 +45,7 @@ from where content is sourced, the `gitlab-docs` project, and the published outp H -- symlink --> G ``` -You will not find any GitLab docs content in the `gitlab-docs` repository. +GitLab docs content isn't kept in the `gitlab-docs` repository. All documentation files are hosted in the respective repository of each product, and all together are pulled to generate the docs website: @@ -55,14 +54,14 @@ product, and all together are pulled to generate the docs website: - [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner/tree/master/docs) - [GitLab Chart](https://gitlab.com/charts/gitlab/tree/master/doc) -NOTE: **Note:** +NOTE: In September 2019, we [moved towards a single codebase](https://gitlab.com/gitlab-org/gitlab/-/issues/2952), as such the docs for CE and EE are now identical. For historical reasons and in order not to break any existing links throughout the internet, we still maintain the CE docs (`https://docs.gitlab.com/ce/`), although it is hidden from the website, and is now a symlink to the EE docs. When [Pages supports redirects](https://gitlab.com/gitlab-org/gitlab-pages/-/issues/24), -we will be able to remove this completely. +we can remove this completely. ## Assets @@ -114,7 +113,7 @@ located in the [Dockerfiles directory](https://gitlab.com/gitlab-org/gitlab-docs If you need to rebuild the Docker images immediately (must have maintainer level permissions): -CAUTION: **Caution:** +WARNING: If you change the dockerfile configuration and rebuild the images, you can break the master pipeline in the main `gitlab` repository as well as in `gitlab-docs`. Create an image with a different name first and test it to ensure you do not break the pipelines. @@ -179,7 +178,7 @@ we reference the array with a symbol (`:versions`). Whenever the custom CSS and JavaScript files under `content/assets/` change, make sure to bump their version in the front matter. This method guarantees that -your changes will take effect by clearing the cache of previous files. +your changes take effect by clearing the cache of previous files. Always use Nanoc's way of including those files, do not hardcode them in the layouts. For example use: @@ -196,7 +195,7 @@ The links pointing to the files should be similar to: <%= @items['/path/to/assets/file.*'].path %> ``` -Nanoc will then build and render those links correctly according with what's +Nanoc then builds and renders those links correctly according with what's defined in [`Rules`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/Rules). ## Linking to source files @@ -236,7 +235,7 @@ If you’re a GitLab team member, find credentials for the Algolia dashboard in the shared [GitLab 1Password account](https://about.gitlab.com/handbook/security/#1password-for-teams). To receive weekly reports of the search usage, search the Google doc with title `Email, Slack, and GitLab Groups and Aliases`, search for `docsearch`, -and add a comment with your email. You'll be added to the alias that gets the weekly +and add a comment with your email to be added to the alias that gets the weekly reports. ## Monthly release process (versions) diff --git a/doc/development/documentation/site_architecture/release_process.md b/doc/development/documentation/site_architecture/release_process.md index 547adc89a08..ba5363dbb71 100644 --- a/doc/development/documentation/site_architecture/release_process.md +++ b/doc/development/documentation/site_architecture/release_process.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # GitLab Docs monthly release process @@ -26,7 +26,7 @@ To add a new charts version: version mapping. Note that only the `major.minor` version is needed. 1. Create a new merge request and merge it. -TIP: **Tip:** +NOTE: It can be handy to create the future mappings since they are pretty much known. In that case, when a new GitLab version is released, you don't have to repeat this first step. @@ -44,14 +44,14 @@ this needs to happen when the stable branches for all products have been created ``` A new `Dockerfile.12.0` should have been created and `.gitlab-ci.yml` should - have the branches variables updated into a new branch. They will be automatically + have the branches variables updated into a new branch. They are automatically committed. 1. Push the newly created branch, but **don't create a merge request**. - Once you push, the `image:docker-singe` job will create a new Docker image + After you push, the `image:docs-single` job creates a new Docker image tagged with the branch name you created in the first step. In the end, the - image will be uploaded in the [Container Registry](https://gitlab.com/gitlab-org/gitlab-docs/container_registry) - and it will be listed under the `registry` environment folder at + image is uploaded in the [Container Registry](https://gitlab.com/gitlab-org/gitlab-docs/container_registry) + and it is listed under the `registry` environment folder at `https://gitlab.com/gitlab-org/gitlab-docs/-/environments/folders/registry` (must have developer access). @@ -66,7 +66,7 @@ Visit `http://localhost:4000/12.0/` to see if everything works correctly. ## 3. Create the release merge request -NOTE: **Note:** +NOTE: To be [automated](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/750). Now it's time to create the monthly release merge request that adds the new @@ -114,20 +114,20 @@ version and rotates the old one: The versions dropdown is in a way "hardcoded". When the site is built, it looks at the contents of `content/_data/versions.yaml` and based on that, the dropdown -is populated. So, older branches will have different content, which means the -dropdown will list one or more releases behind. Remember that the new changes of +is populated. Older branches have different content, which means the +dropdown list is one or more releases behind. Remember that the new changes of the dropdown are included in the unmerged `release-X-Y` branch. The content of `content/_data/versions.yaml` needs to change for all online versions (stable branches `X.Y` of the `gitlab-docs` project): -1. Run the Rake task that will create all the respective merge requests needed to - update the dropdowns and will be set to automatically be merged when their +1. Run the Rake task that creates all the respective merge requests needed to + update the dropdowns. Set these to automatically be merged when their pipelines succeed: - NOTE: **Note:** + NOTE: The `release-X-Y` branch needs to be present locally, - and you need to have switched to it, otherwise the Rake task will fail. + and you need to have switched to it, otherwise the Rake task fails. ```shell git checkout release-X-Y @@ -138,13 +138,13 @@ versions (stable branches `X.Y` of the `gitlab-docs` project): to check that their pipelines pass, and once all are merged, proceed to the following and final step. -TIP: **Tip:** +NOTE: In case a pipeline fails, see [troubleshooting](#troubleshooting). ## 5. Merge the release merge request The dropdown merge requests should have now been merged into their respective -version (stable `X.Y` branch), which will trigger another pipeline. At this point, +version (stable `X.Y` branch), which triggers another pipeline. At this point, you need to only babysit the pipelines and make sure they don't fail: 1. Check the [pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipelines) @@ -152,9 +152,9 @@ you need to only babysit the pipelines and make sure they don't fail: 1. After all the pipelines of the online versions succeed, merge the release merge request. 1. Finally, run the [`Build docker images weekly` pipeline](https://gitlab.com/gitlab-org/gitlab-docs/pipeline_schedules) - that will build the `:latest` and `:archives` Docker images. + that builds the `:latest` and `:archives` Docker images. -Once the scheduled pipeline succeeds, the docs site will be deployed with all +Once the scheduled pipeline succeeds, the docs site is deployed with all new versions online. ## Troubleshooting @@ -163,7 +163,7 @@ Releasing a new version is a long process that involves many moving parts. ### `test_internal_links_and_anchors` failing on dropdown merge requests -DANGER: **Deprecated:** +WARNING: We now pin versions in the `.gitlab-ci.yml` of the respective branch, so the steps below are deprecated. diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index 3cc7f49f05e..fd0c29f0fc1 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -1,7 +1,7 @@ --- stage: none group: Style Guide -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: What to include in GitLab documentation pages. --- @@ -9,7 +9,7 @@ description: What to include in GitLab documentation pages. Use these standards to contribute content to the GitLab documentation. -Before getting started, familiarize yourself with [GitLab's Documentation guidelines](index.md) +Before getting started, familiarize yourself with [Documentation guidelines for GitLab](index.md) and the [Documentation Style Guide](styleguide/index.md). ## Components of a documentation page @@ -39,7 +39,7 @@ pre-deployment and post-deployment tasks. ## Template for new docs -Follow the [folder structure and file name guidelines](styleguide/index.md#folder-structure-overview) +Follow the [folder structure and filename guidelines](styleguide/index.md#folder-structure-overview) and create a new topic by using this template: ```markdown @@ -53,7 +53,7 @@ in Google Search snippets. It may help to write the page intro first, and then r stage: Add the stage name here group: Add the group name here info: To determine the technical writer assigned to the Stage/Group associated with this page, -see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Feature or Use Case Name **[TIER]** (1) diff --git a/doc/development/documentation/styleguide/img/tier_badge.png b/doc/development/documentation/styleguide/img/tier_badge.png Binary files differnew file mode 100644 index 00000000000..674d869da9b --- /dev/null +++ b/doc/development/documentation/styleguide/img/tier_badge.png diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 41e38266a58..971652f76d3 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -1,16 +1,15 @@ --- stage: none group: Style Guide -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: 'Writing styles, markup, formatting, and other standards for GitLab Documentation.' --- # Documentation Style Guide -This document defines the standards for GitLab's documentation content and -files. +This document defines the standards for GitLab documentation. -For broader information about the documentation, see the [Documentation guidelines](index.md). +For broader information about the documentation, see the [Documentation guidelines](../index.md). For guidelines specific to text in the GitLab interface, see the Pajamas [Content](https://design.gitlab.com/content/error-messages/) section. @@ -48,20 +47,20 @@ documentation. ### All information Include problem-solving actions that may address rare cases or be considered -_risky_, so long as proper context is provided in the form of fully detailed +_risky_, but provide proper context through fully-detailed warnings and caveats. This kind of content should be included as it could be helpful to others and, when properly explained, its benefits outweigh the risks. If you think you have found an exception to this rule, contact the Technical Writing team. -We will add all troubleshooting information to the documentation, no matter how +GitLab adds all troubleshooting information to the documentation, no matter how unlikely a user is to encounter a situation. For the [Troubleshooting sections](#troubleshooting), people in GitLab Support can merge additions themselves. ### All media types Include any media types/sources if the content is relevant to readers. You can -freely include or link presentations, diagrams, videos, and so on; no matter who +freely include or link presentations, diagrams, and videos. No matter who it was originally composed for, if it is helpful to any of our audiences, we can include it. @@ -84,25 +83,25 @@ different types. For example, [Divio recommends](https://www.divio.com/blog/docu At GitLab, we have so many product changes in our monthly releases that we can't afford to continuously update multiple types of information. If we have multiple -types, the information will become outdated. Therefore, we have a +types, the information becomes outdated. Therefore, we have a [single template](../structure.md) for documentation. -We currently do not distinguish specific document types, although we are open to +GitLab documentation does not distinguish specific document types. We are open to reconsidering this policy after the documentation has reached a future stage of maturity and quality. If you are reading this, then despite our continuous improvement efforts, that point hasn't been reached. ### Link instead of summarize -There is a temptation to summarize the information on another page. This will -cause the information to live in two places. Instead, link to the single source +There is a temptation to summarize the information on another page, which +causes the information to live in two places. Instead, link to the single source of truth and explain why it is important to consume the information. ### Organize by topic, not by type -Beyond top-level audience-type folders (for example, `administration`), we -organize content by topic, not by type, so it can be located in the -single-source-of-truth (SSOT) section for the subject matter. +We organize content by topic, not by type, so it can be located in the +single-source-of-truth (SSOT) section for the subject matter. Top-level audience-type +folders, like `administration`, are exceptions. For example, do not create groupings of similar media types. For example: @@ -117,38 +116,37 @@ cross-link between any related content. ### Docs-first methodology -We employ a _documentation-first methodology_ to help ensure the documentation -remains a complete and trusted resource, and to make communicating about the use +We employ a _documentation-first methodology_. This method ensures the documentation +remains a complete and trusted resource, and makes communicating about the use of GitLab more efficient. - If the answer to a question exists in documentation, share the link to the documentation instead of rephrasing the information. -- When you encounter new information not available in GitLab’s documentation (for +- When you encounter new information not available in GitLab documentation (for example, when working on a support case or testing a feature), your first step should be to create a merge request (MR) to add this information to the documentation. You can then share the MR to communicate this information. -New information that would be useful toward the future usage or troubleshooting -of GitLab should not be written directly in a forum or other messaging system, -but added to a documentation MR and then referenced, as described above. Note +New information about the future usage or troubleshooting +of GitLab should not be written directly in a forum or other messaging system. +Instead, add it to a documentation merge request, then reference it. Note that among any other documentation changes, you can either: - Add a [Troubleshooting section](#troubleshooting) to a doc if none exists. - Un-comment and use the placeholder Troubleshooting section included as part of our [documentation template](../structure.md#template-for-new-docs), if present. -The more we reflexively add useful information to the documentation, the more -(and more successfully) the documentation will be used to efficiently accomplish -tasks and solve problems. +The more we reflexively add information to the documentation, the more +the documentation helps others efficiently accomplish tasks and solve problems. If you have questions when considering, authoring, or editing documentation, ask -the Technical Writing team on Slack in `#docs` or in GitLab by mentioning the -writer for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages). +the Technical Writing team. They're available on Slack in `#docs` or in GitLab by mentioning the +writer for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). Otherwise, forge ahead with your best effort. It does not need to be perfect; the team is happy to review and improve upon your content. Review the [Documentation guidelines](index.md) before you begin your first documentation MR. -Having a knowledge base in any form that's separate from the documentation would +Maintaining a knowledge base separate from the documentation would be against the documentation-first methodology, because the content would overlap with the documentation. @@ -161,11 +159,11 @@ Markdown rendering engine. For a complete Kramdown reference, see the [GitLab Markdown Kramdown Guide](https://about.gitlab.com/handbook/markdown-guide/). The [`gitlab-kramdown`](https://gitlab.com/gitlab-org/gitlab_kramdown) Ruby gem -will support all [GFM markup](../../../user/markdown.md) in the future, which is -all markup supported for display in the GitLab application itself. For now, use -regular Markdown markup, following the rules in the linked style guide. +plans to support all [GitLab Flavored Markdown](../../../user/markdown.md) in the future, which is +all Markdown supported for display in the GitLab application itself. For now, use +regular Markdown, following the rules in the linked style guide. -Note that Kramdown-specific markup (for example, `{:.class}`) doesn't render +Kramdown-specific markup (for example, `{:.class}`) doesn't render properly on GitLab instances under [`/help`](../index.md#gitlab-help). ### HTML in Markdown @@ -184,7 +182,7 @@ GitLab ensures that the Markdown used across all documentation is consistent, as well as easy to review and maintain, by [testing documentation changes](../testing.md) with [markdownlint](../testing.md#markdownlint). This lint test fails when any document has an issue with Markdown formatting that may cause the page to render -incorrectly within GitLab. It will also fail when a document is using +incorrectly in GitLab. It also fails when a document has non-standard Markdown (which may render correctly, but is not the current standard for GitLab documentation). @@ -194,7 +192,7 @@ A rule that could cause confusion is `MD044/proper-names`, as it might not be immediately clear what caused markdownlint to fail, or how to correct the failure. This rule checks a list of known words, listed in the `.markdownlint.json` file in each project, to verify proper use of capitalization and backticks. -Words in backticks will be ignored by markdownlint. +Words in backticks are ignored by markdownlint. In general, product names should follow the exact capitalization of the official names of the products, protocols, and so on. See [`.markdownlint.json`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.markdownlint.json) @@ -211,7 +209,7 @@ included in backticks. For example: - "Change the `needs` keyword in your `.gitlab.yml`..." - `needs` is a parameter, and `.gitlab.yml` is a file, so both need backticks. - Additionally, `.gitlab.yml` will fail markdownlint without backticks as it + Additionally, `.gitlab.yml` without backticks fails markdownlint because it does not have capital G or L. - "Run `git clone` to clone a Git repository..." - `git clone` is a command, so it must be lowercase, while Git is the product, @@ -241,23 +239,23 @@ to update. Put files for a specific product area into the related folder: -| Directory | What belongs here | -|:----------------------|:----------------------------------------------------------------------------------------------------------------------------------------| -| `doc/user/` | User related documentation. Anything that can be done within the GitLab user interface goes here, including usage of the `/admin` interface. | -| `doc/administration/` | Documentation that requires the user to have access to the server where GitLab is installed. The admin settings that can be accessed by using GitLab's interface exist under `doc/user/admin_area/`. | -| `doc/api/` | API related documentation. | +| Directory | What belongs here | +|:----------------------|:------------------| +| `doc/user/` | User related documentation. Anything that can be done in the GitLab user interface goes here, including usage of the `/admin` interface. | +| `doc/administration/` | Documentation that requires the user to have access to the server where GitLab is installed. Administrator settings in the GitLab user interface are under `doc/user/admin_area/`. | +| `doc/api/` | API-related documentation. | | `doc/development/` | Documentation related to the development of GitLab, whether contributing code or documentation. Related process and style guides should go here. | -| `doc/legal/` | Legal documents about contributing to GitLab. | -| `doc/install/` | Contains instructions for installing GitLab. | -| `doc/update/` | Contains instructions for updating GitLab. | -| `doc/topics/` | Indexes per topic (`doc/topics/topic_name/index.md`): all resources for that topic. | +| `doc/legal/` | Legal documents about contributing to GitLab. | +| `doc/install/` | Contains instructions for installing GitLab. | +| `doc/update/` | Contains instructions for updating GitLab. | +| `doc/topics/` | Indexes per topic (`doc/topics/topic_name/index.md`): all resources for that topic. | ### Work with directories and files Refer to the following items when working with directories and files: 1. When you create a new directory, always start with an `index.md` file. - Don't use another file name and _do not_ create `README.md` files. + Don't use another filename and _do not_ create `README.md` files. 1. _Do not_ use special characters and spaces, or capital letters in file names, directory names, branch names, and anything that generates a path. 1. When creating or renaming a file or directory and it has more than one word @@ -277,24 +275,24 @@ Refer to the following items when working with directories and files: Every page you would navigate under `/profile` should have its own document, for example, `account.md`, `applications.md`, or `emails.md`. - `doc/user/dashboard/` should contain all dashboard related documentation. - - `doc/user/admin_area/` should contain all admin related documentation - describing what can be achieved by accessing GitLab's admin interface - (_not to be confused with `doc/administration` where server access is - required_). + - `doc/user/admin_area/` should contain all administrator-related + documentation describing what can be achieved by accessing the GitLab + administrator interface (not to be confused with `doc/administration` where + server access is required). - Every category under `/admin/application_settings/` should have its own document located at `doc/user/admin_area/settings/`. For example, the **Visibility and Access Controls** category should have a document located at `doc/user/admin_area/settings/visibility_and_access_controls.md`. 1. The `doc/topics/` directory holds topic-related technical content. Create `doc/topics/topic_name/subtopic_name/index.md` when subtopics become necessary. - General user- and admin- related documentation, should be placed accordingly. + General user and administrator documentation should be placed accordingly. 1. The `/university/` directory is *deprecated* and the majority of its documentation has been moved. If you're unsure where to place a document or a content addition, this shouldn't stop you from authoring and contributing. Use your best judgment, and then ask -the reviewer of your MR to confirm your decision, or ask a technical writer at -any stage in the process. The technical writing team will review all +the reviewer of your MR to confirm your decision. You can also ask a technical writer at +any stage in the process. The technical writing team reviews all documentation changes, regardless, and can move content if there is a better place for it. @@ -305,9 +303,9 @@ Do not include the same information in multiple places. ### References across documents -- Give each folder an `index.md` page that introduces the topic, introduces the - pages within, and links to the pages within (including to the index pages of - any next-level subpaths). +- Give each folder an `index.md` page that introduces the topic, and both introduces + and links to the child pages, including to the index pages of + any next-level sub-paths. - To ensure discoverability, ensure each new or renamed doc is linked from its higher-level index page and other related pages. - When making reference to other GitLab products and features, link to their @@ -315,7 +313,7 @@ Do not include the same information in multiple places. - When making reference to third-party products or technologies, link out to their external sites, documentation, and resources. -### Structure within documents +### Structure in documents - Include any and all applicable subsections as described on the [structure and template](../structure.md) page. @@ -331,11 +329,12 @@ GitLab documentation should be clear and easy to understand. - Write in US English with US grammar. (Tested in [`British.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/British.yml).) - Use [inclusive language](#inclusive-language). -### Point of view +### Trademark -In most cases, it’s appropriate to use the second-person (you, yours) point of -view, because it’s friendly and easy to understand. (Tested in -[`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).) +Only use the GitLab name and trademarks in accordance with +[GitLab Brand Guidelines](https://about.gitlab.com/handbook/marketing/inbound-marketing/digital-experience/brand-guidelines/#trademark). + +Don't use the possessive form of the word GitLab (`GitLab's`). ### Capitalization @@ -353,7 +352,7 @@ item, use the same capitalization that's displayed in the user interface. Standards for this content are listed in the [Pajamas Design System Content section](https://design.gitlab.com/content/punctuation/) and typically match what's called for in this Documentation Style Guide. -If you think there's a mistake in the way the user interface text is styled, +If you think the user interface text contains style mistakes, create an issue or an MR to propose a change to the user interface text. #### Feature names @@ -524,78 +523,35 @@ You can use the following fake tokens as examples: | Health check token | `Tu7BgjR9qeZTEyRzGG2P` | | Request profile token | `7VgpS4Ax5utVD2esNstz` | -### Language to avoid - -When creating documentation, limit or avoid the use of the following verb -tenses, words, and phrases: - -- Avoid jargon when possible, and when not possible, define the term or - [link to a definition](#links-to-external-documentation). -- Avoid uncommon words when a more-common alternative is possible, ensuring that - content is accessible to more readers. -- Don't write in the first person singular. - (Tested in [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).) - - Instead of _I_ or _me_, use _we_, _you_, _us_, or _one_. - - When possible, stay user focused by writing in the second person (_you_ or - the imperative). -- Don't overuse "that". In many cases, you can remove "that" from a sentence - and improve readability. -- Avoid use of the future tense: - - Instead of "after you execute this command, GitLab will display the - result", use "after you execute this command, GitLab displays the result". - - Only use the future tense to convey when the action or result will actually - occur at a future time. -- Don't use slashes to clump different words together or as a replacement for - the word "or": - - Instead of "and/or," consider using "or," or use another sensible - construction. - - Other examples include "clone/fetch," author/assignee," and - "namespace/repository name." Break apart any such instances in an - appropriate way. - - Exceptions to this rule include commonly accepted technical terms, such as - CI/CD and TCP/IP. -<!-- vale gitlab.LatinTerms = NO --> -- We discourage the use of Latin abbreviations and terms, such as _e.g._, - _i.e._, _etc._, or _via_, as even native users of English can misunderstand - those terms. (Tested in [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml).) - - Instead of _i.e._, use _that is_. - - Instead of _via_, use _through_. - - Instead of _e.g._, use _for example_, _such as_, _for instance_, or _like_. - - Instead of _etc._, either use _and so on_ or consider editing it out, since - it can be vague. -<!-- vale gitlab.LatinTerms = YES --> -- Avoid using the word *currently* when talking about the product or its - features. The documentation describes the product as it is, and not as it - will be at some indeterminate point in the future. -- Avoid the using the word *scalability* with increasing GitLab's performance - for additional users. Using the words *scale* or *scaling* in other cases is - acceptable, but references to increasing GitLab's performance for additional - users should direct readers to the GitLab - [reference architectures](../../../administration/reference_architectures/index.md) - page. -- Avoid all forms of the phrases *high availability* and *HA*, and instead - direct readers to the GitLab [reference architectures](../../../administration/reference_architectures/index.md) - for information about configuring GitLab to have the performance needed for - additional users over time. -- Don't use profanity or obscenities. Doing so may negatively affect other - users and contributors, which is contrary to GitLab's value of - [Diversity, Inclusion, and Belonging](https://about.gitlab.com/handbook/values/#diversity-inclusion). -- Avoid the use of [racially-insensitive terminology or phrases](https://www.marketplace.org/2020/06/17/tech-companies-update-language-to-avoid-offensive-terms/). For example: - - Use *primary* and *secondary* for database and server relationships. - - Use *allowlist* and *denylist* to describe access control lists. -- Avoid the word _please_. For details, see the [Microsoft style guide](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/p/please). -- Avoid words like _easily_, _simply_, _handy_, and _useful._ If the user - doesn't find the process to be these things, we lose their trust. - -### Word usage clarifications - -- Don't use "may" and "might" interchangeably: - - Use "might" to indicate the probability of something occurring. "If you - skip this step, the import process might fail." - - Use "may" to indicate giving permission for someone to do something, or - consider using "can" instead. "You may select either option on this - screen." Or, "You can select either option on this screen." - +### Usage list +<!-- vale off --> + +| Usage | Guidance | +|-----------------------|-----| +| admin, admin area | Use **administration**, **administrator**, **administer**, or **Admin Area** instead. |. +| and/or | Use **or** instead, or another sensible construction. | +| currently | Do not use when talking about the product or its features. The documentation describes the product as it is today. | +| easily | Do not use. If the user doesn't find the process to be these things, we lose their trust. | +| e.g. | Do not use Latin abbreviations. Use **for example**, **such as**, **for instance**, or **like** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml)) | +| future tense | When possible, use present tense instead. For example, use `after you execute this command, GitLab displays the result` instead of `after you execute this command, GitLab will display the result`. ([Vale](../testing.md#vale) rule: [`FutureTense.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FutureTense.yml)) | +| handy | Do not use. If the user doesn't find the process to be these things, we lose their trust. | +| high availability, HA | Do not use. Instead, direct readers to the GitLab [reference architectures](../../../administration/reference_architectures/index.md) for information about configuring GitLab for handling greater amounts of users. | +| I | Do not use first-person singular. Use **you**, **we**, or **us** instead. ([Vale](../testing.md#vale) rule: [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml)) | +| i.e. | Do not use Latin abbreviations. Use **that is** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml)) | +| jargon | Do not use. Define the term or [link to a definition](#links-to-external-documentation). | +| may, might | **Might** means something has the probability of occurring. **May** gives permission to do something. Consider **can** instead of **may**. | +| me, myself, mine | Do not use first-person singular. Use **you**, **we**, or **us** instead. ([Vale](../testing.md#vale) rule: [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml)) | +| please | Do not use. For details, see the [Microsoft style guide](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/p/please). | +| profanity | Do not use. Doing so may negatively affect other users and contributors, which is contrary to the GitLab value of [Diversity, Inclusion, and Belonging](https://about.gitlab.com/handbook/values/#diversity-inclusion). | +| scalability | Do not use when talking about increasing GitLab performance for additional users. The words scale or scaling are sometimes acceptable, but references to increasing GitLab performance for additional users should direct readers to the GitLab [reference architectures](../../../administration/reference_architectures/index.md) page. | +| simply | Do not use. If the user doesn't find the process to be these things, we lose their trust. | +| slashes | Instead of **and/or**, use **or** or another sensible construction. This rule also applies to other slashes, like **follow/unfollow**. Some exceptions (like **CI/CD**) are allowed. | +| that | Do not use. Example: `the file that you save` can be `the file you save`. | +| useful | Do not use. If the user doesn't find the process to be these things, we lose their trust. | +| utilize | Do not use. Use **use** instead. It's more succinct and easier for non-native English speakers to understand. | +| via | Do not use Latin abbreviations. Use **with**, **through**, or **by using** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml)) | + +<!-- vale on --> ### Contractions Contractions are encouraged, and can create a friendly and informal tone, @@ -604,11 +560,13 @@ especially in tutorials, instructional documentation, and Some contractions, however, should be avoided: +- Do not use [the word GitLab in a contraction](#trademark). + - Do not use contractions with a proper noun and a verb. For example: | Do | Don't | |------------------------------------------|-----------------------------------------| - | GitLab is creating X. | GitLab's creating X. | + | Canada is establishing X. | Canada's establishing X. | - Do not use contractions when you need to emphasize a negative. For example: @@ -674,8 +632,8 @@ Follow these guidelines for punctuation: ### Placeholder text -Often in examples, a writer will provide a command or configuration that -uses values specific to the reader. +You might want to provide a command or configuration that +uses specific values. In these cases, use [`<` and `>`](https://en.wikipedia.org/wiki/Usage_message#Pattern) to call out where a reader must replace text with their own value. @@ -691,12 +649,23 @@ cp <your_source_directory> <your_destination_directory> Use the HTML `<kbd>` tag when referring to keystroke presses. For example: ```plaintext -To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>. +To stop the command, press <kbd>Control</kbd>+<kbd>C</kbd>. ``` When the docs are generated, the output is: -To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>. +To stop the command, press <kbd>Control</kbd>+<kbd>C</kbd>. + +### Spaces between words + +Use only standard spaces between words. The search engine for the documentation +website doesn't split words separated with +[non-breaking spaces](https://en.wikipedia.org/wiki/Non-breaking_space) when +indexing, and fails to create expected individual search terms. Tests that search +for certain words separated by regular spaces can't find words separated by +non-breaking spaces. + +Tested in [`lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/lint-doc.sh). ## Lists @@ -733,7 +702,7 @@ This is a list of available features: - Use dashes (`-`) for unordered lists instead of asterisks (`*`). - Prefix `1.` to every item in an ordered list. When rendered, the list items - will appear with sequential numbering. + display with sequential numbering. ### Punctuation @@ -793,6 +762,8 @@ Items nested in lists should always align with the first character of the list item. In unordered lists (using `-`), this means two spaces for each level of indentation: +<!-- vale off --> + ````markdown - Unordered list item 1 @@ -806,7 +777,7 @@ indentation: - Unordered list item 3 ```plaintext - a codeblock that will next inside list item 3 + a code block that nests inside list item 3 ``` - Unordered list item 4 @@ -814,8 +785,12 @@ indentation:  ```` +<!-- vale on --> + For ordered lists, use three spaces for each level of indentation: +<!-- vale off --> + ````markdown 1. Ordered list item 1 @@ -829,7 +804,7 @@ For ordered lists, use three spaces for each level of indentation: 1. Ordered list item 3 ```plaintext - a codeblock that will next inside list item 3 + a code block that nests inside list item 3 ``` 1. Ordered list item 4 @@ -837,6 +812,8 @@ For ordered lists, use three spaces for each level of indentation:  ```` +<!-- vale on --> + You can nest full lists inside other lists using the same rules as above. If you want to mix types, that's also possible, if you don't mix items at the same level: @@ -864,7 +841,7 @@ that's best described by a matrix, tables are the best choice. ### Creation guidelines -Due to accessibility and scannability requirements, tables should not have any +To keep tables accessible and scannable, tables should not have any empty cells. If there is no otherwise meaningful value for a cell, consider entering *N/A* (for 'not applicable') or *none*. @@ -886,9 +863,9 @@ Consider installing a plugin or extension in your editor for formatting tables: ### Feature tables -When creating tables of lists of features (such as whether or not features are -available to certain roles on the [Permissions](../../../user/permissions.md#project-members-permissions) -page), use the following phrases (based on the SVG icons): +When creating tables of lists of features (such the features +available to each role on the [Permissions](../../../user/permissions.md#project-members-permissions) +page), use the following phrases: | Option | Markdown | Displayed result | |--------|--------------------------|------------------------| @@ -901,8 +878,8 @@ Valid for Markdown content only, not for front matter entries: - Standard quotes: double quotes (`"`). Example: "This is wrapped in double quotes". -- Quote within a quote: double quotes (`"`) wrap single quotes (`'`). Example: - "I am 'quoting' something within a quote". +- Quote inside a quote: double quotes (`"`) wrap single quotes (`'`). Example: + "This sentence 'quotes' something in a quote". For other punctuation rules, refer to the [GitLab UX guide](https://design.gitlab.com/content/punctuation/). @@ -910,7 +887,7 @@ For other punctuation rules, refer to the ## Headings - Add _only one H1_ in each document, by adding `#` at the beginning of - it (when using Markdown). The `h1` will be the document `<title>`. + it (when using Markdown). The `h1` becomes the document `<title>`. - Start with an `h2` (`##`), and respect the order `h2` > `h3` > `h4` > `h5` > `h6`. Never skip the hierarchy level, such as `h2` > `h4` - Avoid putting numbers in headings. Numbers shift, hence documentation anchor @@ -922,16 +899,16 @@ For other punctuation rules, refer to the - When possible, avoid including words that might change in the future. Changing a heading changes its anchor URL, which affects other linked pages. - When introducing a new document, be careful for the headings to be - grammatically and syntactically correct. Mention an [assigned technical writer (TW)](https://about.gitlab.com/handbook/product/product-categories/) + grammatically and syntactically correct. Mention an [assigned technical writer (TW)](https://about.gitlab.com/handbook/product/categories/) for review. This is to ensure that no document with wrong heading is going live without an audit, thus preventing dead links and redirection issues when corrected. - Leave exactly one blank line before and after a heading. - Do not use links in headings. -- Add the corresponding [product badge](#product-badges) according to the tier the +- Add the corresponding [product badge](#product-tier-badges) according to the tier the feature belongs. - Our documentation site search engine prioritizes words used in headings and - subheadings. Make you subheading titles clear, descriptive, and complete to help + subheadings. Make your subheading titles clear, descriptive, and complete to help users find the right example, as shown in the section on [heading titles](#heading-titles). - See [Capitalization](#capitalization) for guidelines on capitalizing headings. @@ -943,54 +920,52 @@ search engine optimization (SEO), use the imperative, where possible. | Do | Don't | |:--------------------------------------|:------------------------------------------------------------| | Configure GDK | Configuring GDK | -| GitLab Release and Maintenance Policy | This section covers GitLab's Release and Maintenance Policy | +| GitLab Release and Maintenance Policy | This section covers the GitLab Release and Maintenance Policy | | Backport to older releases | Backporting to older releases | | GitLab Pages examples | Examples | For guidelines on capitalizing headings, see the section on [capitalization](#capitalization). -NOTE: **Note:** -If you change an existing title, be careful. These changes might affect not -only [links](#anchor-links) within the page, but might also affect links to the -GitLab documentation from both the GitLab application and external sites. +NOTE: +If you change an existing title, be careful. In-page [anchor links](#anchor-links), +links in the GitLab application, and links from external sites can break. ### Anchor links Headings generate anchor links when rendered. `## This is an example` generates the anchor `#this-is-an-example`. -NOTE: **Note:** +NOTE: [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39717) in -GitLab 13.4, [product badges](#product-badges) used in headings aren't included -in the generated anchor links. For example, when you link to +GitLab 13.4, [product badges](#product-tier-badges) used in headings aren't +included in the generated anchor links. For example, when you link to `## This is an example **(CORE)**`, use the anchor `#this-is-an-example`. Keep in mind that the GitLab user interface links to many documentation pages -and anchor links to take the user to the right spot. Therefore, when you change +and anchor links to take the user to the right spot. When you change a heading, search `doc/*`, `app/views/*`, and `ee/app/views/*` for the old -anchor to make sure you're not breaking an anchor linked from other -documentation nor from the GitLab user interface. If you find the old anchor, be -sure to replace it with the new one. +anchor. If you do not fix these links, the [`ui-docs-lint` job](../testing.md#ui-link-tests) +in your merge request fails. Important: - Avoid crosslinking documentation to headings unless you need to link to a - specific section of the document. This will avoid breaking anchors in the + specific section of the document. This avoids breaking anchors in the future in case the heading is changed. -- If possible, avoid changing headings since they're not only linked internally. +- If possible, avoid changing headings, because they're not only linked internally. There are various links to GitLab documentation on the internet, such as tutorials, presentations, StackOverflow posts, and other sources. - Do not link to `h1` headings. -Note that, with Kramdown, it is possible to add a custom ID to an HTML element -with Markdown markup, but they _do not_ work in GitLab's `/help`. Therefore, -do not use this option until further notice. +Note that with Kramdown, it's possible to add a custom ID to an HTML element +with Markdown markup, but they don't work in `/help`. Because of this, don't use +this option. ## Links Links are important in GitLab documentation. They allow you to [link instead of summarizing](#link-instead-of-summarize) to help preserve a [single source of truth](#why-a-single-source-of-truth) -within GitLab documentation. +in GitLab documentation. We include guidance for links in the following categories: @@ -1004,7 +979,7 @@ We include guidance for links in the following categories: for authoritative sources. - When to use [links requiring permissions](#links-requiring-permissions). - How to set up a [link to a video](#link-to-video). -- How to [include links with version text](#text-for-documentation-requiring-version-text). +- How to [include links with version text](#where-to-put-version-text). - How to [link to specific lines of code](#link-to-specific-lines-of-code) ### Basic link criteria @@ -1018,13 +993,13 @@ We include guidance for links in the following categories: ### Links to internal documentation -NOTE: **Note:** +NOTE: _Internal_ refers to documentation in the same project. When linking to documentation in separate projects (for example, linking to Omnibus documentation from GitLab documentation), you must use absolute URLs. Do not use absolute URLs like `https://docs.gitlab.com/ee/index.html` to -crosslink to other documentation within the same project. Use relative links to +cross-link to other documentation in the same project. Use relative links to the file, like `../index.md`. (These are converted to HTML when the site is rendered.) @@ -1033,7 +1008,7 @@ Relative linking enables crosslinks to work: - in Review Apps, local previews, and `/help`. - when working on the documentation locally, so you can verify that they work as early as possible in the process. -- within the GitLab user interface when browsing doc files in their respective +- in the GitLab user interface when browsing doc files in their respective repositories. For example, the links displayed at `https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/README.md`. @@ -1053,7 +1028,7 @@ To link to internal documentation: Do: `../../geo/replication/troubleshooting.md` -- Always add the file name `file.md` at the end of the link with the `.md` +- Always add the filename `file.md` at the end of the link with the `.md` extension, not `.html`. Don't: @@ -1068,7 +1043,7 @@ To link to internal documentation: - `../../issues/tags.md` - `../../issues/tags.md#stages` -NOTE: **Note:** +NOTE: Using the Markdown extension is necessary for the [`/help`](../index.md#gitlab-help) section of GitLab. @@ -1109,7 +1084,7 @@ While many of these sources to avoid can help you learn skills and or features, they can become obsolete quickly. Nobody is obliged to maintain any of these sites. Therefore, we should avoid using them as reference literature. -NOTE: **Note:** +NOTE: Non-authoritative sources are acceptable only if there is no equivalent authoritative source. Even then, focus on non-authoritative sources that are extensively cited or peer-reviewed. @@ -1122,7 +1097,7 @@ Don't link directly to: - Project features that require [special permissions](../../../user/permissions.md) to view. -These will fail for: +These fail for: - Those without sufficient permissions. - Automated link checkers. @@ -1143,16 +1118,16 @@ For more information, see the [confidential issue](../../../user/project/issues/ ### Link to specific lines of code -When linking to specific lines within a file, link to a commit instead of to the -branch. Lines of code change through time, therefore, linking to a line by using +When linking to specific lines in a file, link to a commit instead of to the +branch. Lines of code change over time. Linking to a line by using the commit link ensures the user lands on the line you're referring to. The -**Permalink** button, which is available when viewing a file within a project, -makes it easy to generate a link to the most recent commit of the given file. +**Permalink** button, displayed when viewing a file in a project, +provides a link to the most recent commit of that file. - _Do_: `[link to line 3](https://gitlab.com/gitlab-org/gitlab/-/blob/11f17c56d8b7f0b752562d78a4298a3a95b5ce66/.gitlab/issue_templates/Feature%20proposal.md#L3)` - _Don't_: `[link to line 3](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/issue_templates/Feature%20proposal.md#L3).` -If that linked expression is no longer in that line of the file due to additional +If that linked expression has changed line numbers due to additional commits, you can still search the file for that query. In this case, update the document to ensure it links to the most recent version of the file. @@ -1206,9 +1181,9 @@ When you take screenshots: ### Save the image -- Save the image with a lowercase file name that's descriptive of the feature +- Save the image with a lowercase filename that's descriptive of the feature or concept in the image. If the image is of the GitLab interface, append the - GitLab version to the file name, based on the following format: + GitLab version to the filename, based on the following format: `image_name_vX_Y.png`. For example, for a screenshot taken from the pipelines page of GitLab 11.1, a valid name is `pipelines_v11_1.png`. If you're adding an illustration that doesn't include parts of the user interface, add the release @@ -1218,10 +1193,10 @@ When you take screenshots: the `.md` document that you're working on is located. - Consider using PNG images instead of JPEG. - [Compress all PNG images](#compress-images). -- Compress gifs with <https://ezgif.com/optimize> or similar tool. +- Compress GIFs with <https://ezgif.com/optimize> or similar tool. - Images should be used (only when necessary) to _illustrate_ the description of a process, not to _replace_ it. -- Max image size: 100KB (gifs included). +- Max image size: 100KB (GIFs included). - See also how to link and embed [videos](#videos) to illustrate the documentation. @@ -1268,12 +1243,14 @@ request. ## Videos -Adding GitLab's existing YouTube video tutorials to the documentation is highly +Adding GitLab YouTube video tutorials to the documentation is highly encouraged, unless the video is outdated. Videos should not replace documentation, but complement or illustrate it. If content in a video is -fundamental to a feature and its key use cases, but this is not adequately -covered in the documentation, add this detail to the documentation text or -create an issue to review the video and do so. +fundamental to a feature and its key use cases, but isn't adequately +covered in the documentation, you should: + +- Add this detail to the documentation text. +- Create an issue to review the video and update the page. Do not upload videos to the product repositories. [Link](#link-to-video) or [embed](#embed-videos) them instead. @@ -1297,11 +1274,11 @@ You can link any up-to-date video that's useful to the GitLab user. The [GitLab documentation site](https://docs.gitlab.com) supports embedded videos. -You can only embed videos from [GitLab's official YouTube account](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg). +You can embed videos from [the official YouTube account for GitLab](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg) only. For videos from other sources, [link](#link-to-video) them instead. -In most cases, it is better to [link to video](#link-to-video) instead, because -an embed takes up a lot of space on the page and can be distracting to readers. +In most cases, [link to a video](#link-to-video), because +embedded videos take up a lot of space on the page and can be distracting to readers. To embed a video: @@ -1341,9 +1318,9 @@ This is how it renders on the GitLab documentation site: > - The `figure` tag is required for semantic SEO and the `video_container` class is necessary to make sure the video is responsive and displays on different mobile devices. -> - The `<div class="video-fallback">` is a fallback necessary for GitLab's -`/help`, as GitLab's Markdown processor does not support iframes. It's hidden on -the documentation site, but will be displayed on GitLab's `/help`. +> - The `<div class="video-fallback">` is a fallback necessary for +`/help`, because the GitLab Markdown processor doesn't support iframes. It's +hidden on the documentation site, but is displayed by `/help`. ## Code blocks @@ -1361,10 +1338,12 @@ the documentation site, but will be displayed on GitLab's `/help`. and leave a blank line between the command and the output. - When providing a command without output, don't prefix the shell command with `$`. - If you need to include triple backticks inside a code block, use four backticks - for the codeblock fences instead of three. + for the code block fences instead of three. - For regular fenced code blocks, always use a highlighting class corresponding to the language for better readability. Examples: + <!-- vale off --> + ````markdown ```ruby Ruby code @@ -1383,6 +1362,8 @@ the documentation site, but will be displayed on GitLab's `/help`. ``` ```` + <!-- vale on --> + Syntax highlighting is required for fenced code blocks added to the GitLab documentation. Refer to the following table for the most common language classes, or check the [complete list](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers) @@ -1398,7 +1379,7 @@ of available language classes: | `graphql` | | | `haml` | | | `html` | | -| `ini` | For some simple config files that are not in TOML format. | +| `ini` | For some simple configuration files that are not in TOML format. | | `javascript` | Alias `js`. | | `json` | | | `markdown` | Alias: `md`. | @@ -1406,7 +1387,7 @@ of available language classes: | `nginx` | | | `perl` | | | `php` | | -| `plaintext` | Examples with no defined language, such as output from shell commands or API calls. If a codeblock has no language, it defaults to `plaintext`. Alias: `text`. | +| `plaintext` | Examples with no defined language, such as output from shell commands or API calls. If a code block has no language, it defaults to `plaintext`. Alias: `text`.| | `prometheus` | Prometheus configuration examples. | | `python` | | | `ruby` | Alias: `rb`. | @@ -1436,7 +1417,7 @@ Usage examples: Example: `**{tanuki}**` renders as: **{tanuki}**. - Icon with custom size: `**{icon-name, size}**` - Available sizes (in px): 8, 10, 12, 14, 16, 18, 24, 32, 48, and 72 + Available sizes (in pixels): 8, 10, 12, 14, 16, 18, 24, 32, 48, and 72 Example: `**{tanuki, 24}**` renders as: **{tanuki, 24}**. - Icon with custom size and class: `**{icon-name, size, class-name}**`. @@ -1467,14 +1448,14 @@ interface: | Section | Description | |:-------------------------|:----------------------------------------------------------------------------------------------------------------------------| | **{overview}** Overview | View your GitLab Dashboard, and administer projects, users, groups, jobs, runners, and Gitaly servers. | -| **{monitor}** Monitoring | View GitLab system information, and information on background jobs, logs, health checks, requests profiles, and audit logs. | +| **{monitor}** Monitoring | View GitLab system information, and information on background jobs, logs, health checks, requests profiles, and audit events. | | **{messages}** Messages | Send and manage broadcast messages for your users. | ``` | Section | Description | |:-------------------------|:----------------------------------------------------------------------------------------------------------------------------| | **{overview}** Overview | View your GitLab Dashboard, and administer projects, users, groups, jobs, runners, and Gitaly servers. | -| **{monitor}** Monitoring | View GitLab system information, and information on background jobs, logs, health checks, requests profiles, and audit logs. | +| **{monitor}** Monitoring | View GitLab system information, and information on background jobs, logs, health checks, requests profiles, and audit events. | | **{messages}** Messages | Send and manage broadcast messages for your users. | Use an icon when you find yourself having to describe an interface element. For @@ -1485,102 +1466,72 @@ example: ## Alert boxes -When you need to call special attention to particular sentences, use the -following markup to create highlighted alert boxes. +Use alert boxes to call attention to information. -Alert boxes work for one paragraph only. Multiple paragraphs, lists, and headers -won't render correctly. For multiple lines, use [blockquotes](#blockquotes) -instead. +Alert boxes are generated when the words `NOTE:` or `WARNING:` are followed by a +line break. For example: -Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.com>). -In the GitLab product help, alert boxes appear as plain Markdown text. +```markdown +NOTE: +This is something to note. +``` -These alert boxes are used in the GitLab documentation. These aren't strict -guidelines, but for consistency you should try to use these values: +To display an alert box for multiple paragraphs, lists, or headers, use +[blockquotes](#blockquotes) instead. -| Color | Markup | Default keyword | Alternative keywords | -|--------|------------|-----------------|----------------------------------------------------------------------| -| Blue | `NOTE:` | `**Note:**` | | -| Yellow | `CAUTION:` | `**Caution:**` | `**Warning:**`, `**Important:**` | -| Red | `DANGER:` | `**Danger:**` | `**Warning:**`, `**Important:**`, `**Deprecated:**`, `**Required:**` | -| Green | `TIP:` | `**Tip:**` | | +Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.com>). +In the GitLab product help, alert boxes appear as plain text. ### Note -Notes indicate additional information that's of special use to the reader. -Notes are most effective when used _sparingly_. +Use notes sparingly. Too many notes can make topics difficult to scan. -Try to avoid them. Too many notes can impact the scannability of a topic and -create an overly busy page. +Instead of adding a note: -Instead of adding a note, try one of these alternatives: +- Re-write the sentence as part of a paragraph. +- Put the information into its own paragraph. +- Put the content under a new subheading. -- Re-write the sentence as part of the most-relevant paragraph. -- Put the information into its own standalone paragraph. -- Put the content under a new subheading that introduces the topic, which makes - it more visible. - -If you must use a note, use the following formatting: +If you must use a note, use this format: ```markdown -NOTE: **Note:** +NOTE: This is something to note. ``` -How it renders on the GitLab documentation site: +It renders on the GitLab documentation site as: -NOTE: **Note:** +NOTE: This is something to note. -### Tip - -```markdown -TIP: **Tip:** -This is a tip. -``` - -How it renders on the GitLab documentation site: - -TIP: **Tip:** -This is a tip. - -### Caution - -```markdown -CAUTION: **Caution:** -This is something to be cautious about. -``` - -How it renders on the GitLab documentation site: - -CAUTION: **Caution:** -This is something to be cautious about. +### Warning -### Danger +Use a warning to indicate deprecated features, or to provide a warning about +procedures that have the potential for data loss. ```markdown -DANGER: **Warning:** -This is a breaking change, a bug, or something very important to note. +WARNING: +This is something to be warned about. ``` -How it renders on the GitLab documentation site: +It renders on the GitLab documentation site as: -DANGER: **Warning:** -This is a breaking change, a bug, or something very important to note. +WARNING: +This is something to be warned about. ## Blockquotes -For highlighting a text within a blue blockquote, use this format: +For highlighting a text inside a blockquote, use this format: ```markdown > This is a blockquote. ``` -which renders on the [GitLab documentation site](https://docs.gitlab.com) as: +It renders on the GitLab documentation site as: > This is a blockquote. -If the text spans across multiple lines it's OK to split the line. +If the text spans multiple lines, you can split them. For multiple paragraphs, use the symbol `>` before every line: @@ -1593,7 +1544,7 @@ For multiple paragraphs, use the symbol `>` before every line: > - Second item in the list ``` -Which renders to: +It renders on the GitLab documentation site as: > This is the first paragraph. > @@ -1610,7 +1561,7 @@ documentation authors on agreed styles and usage of terms. ### Merge requests (MRs) Merge requests allow you to exchange changes you made to source code and -collaborate with other people on the same project. You'll see this term used in +collaborate with other people on the same project. This term is used in the following ways: - Use lowercase _merge requests_ regardless of whether referring to the feature @@ -1654,36 +1605,43 @@ elements: |:------------|:--------------------------------|:----------------------| | _go to_ | making a browser go to location | "navigate to", "open" | -## GitLab versions and tiers +## GitLab versions -Tagged and released versions of GitLab documentation are available: +GitLab product documentation pages (not including [Contributor and Development](../../README.md) +pages in the `/development` directory) can include version information to help +users be aware of recent improvements or additions. -- In the [documentation archives](https://docs.gitlab.com/archives/). -- At the `/help` URL for any GitLab installation. +The GitLab Technical Writing team determines which versions of +documentation to display on this site based on the GitLab +[Statement of Support](https://about.gitlab.com/support/statement-of-support.html#we-support-the-current-major-version-and-the-two-previous-major-versions). -The version introducing a new feature is added to the top of the topic in the -documentation to provide a link back to how the feature was developed. +### View older GitLab documentation versions -TIP: **Tip:** -Whenever you have documentation related to the `gitlab.rb` file, you're working -with a self-managed installation. The section or page is therefore likely to -apply only to self-managed instances. If so, the relevant "`TIER` ONLY" -[Product badge](#product-badges) should be included at the highest applicable -heading level. +Older versions of GitLab may no longer have documentation available from `docs.gitlab.com`. +If documentation for your version is no longer available from `docs.gitlab.com`, you can still view a +tagged and released set of documentation for your installed version: -### Text for documentation requiring version text +- In the [documentation archives](https://docs.gitlab.com/archives/). +- At the `/help` URL of your GitLab instance. +- In the documentation repository based on the respective branch (for example, + the [13.2 branch](https://gitlab.com/gitlab-org/gitlab/-/tree/13-2-stable-ee/doc)). -When a feature is new or updated, you can add version information as a bulleted -item in the **Version history**, or as an inline reference with related text. +### Where to put version text + +When a feature is added or updated, you can include its version information +either as a **Version history** item or as an inline text reference. + +Version text shouldn't include information about the tier in which the feature +is available. This information is provided by the [product badge](#product-tier-badges) +displayed for the page or feature. #### Version text in the **Version History** -If all content in a section is related, add version text following the header for -the section. Each entry should be on a single line. To render correctly, it must be on its -own line and surrounded by blank lines. +If all content in a section is related, add version text following the header +for the section. The version information must be surrounded by blank lines, and +each entry should be on its own line. -Features should declare the GitLab version that introduced a feature in a blockquote -following the header: +Add the version history information as a blockquote: ```markdown ## Feature name @@ -1693,24 +1651,16 @@ following the header: This feature does something. ``` -Whenever possible, version text should have a link to the _completed_ issue, -merge request, or epic that introduced the feature. An issue is preferred over -a merge request, and a merge request is preferred over an epic. For example: +Whenever possible, version text should have a link to the completed issue, merge +request, or epic that introduced the feature. An issue is preferred over a merge +request, and a merge request is preferred over an epic. For example: ```markdown > [Introduced](<link-to-issue>) in GitLab 11.3. ``` -If the feature is only available in GitLab Enterprise Edition, mention -the [paid tier](https://about.gitlab.com/handbook/marketing/strategic-marketing/tiers/) -the feature is available in: - -```markdown -> [Introduced](<link-to-issue>) in [GitLab Starter](https://about.gitlab.com/pricing/) 11.3. -``` - -If listing information for multiple version as a feature evolves, add the -information to a block-quoted bullet list. For example: +If you're adding information about new features or changes in a release, update +the blockquote to use a bulleted list: ```markdown > - [Introduced](<link-to-issue>) in GitLab 11.3. @@ -1720,9 +1670,8 @@ information to a block-quoted bullet list. For example: If a feature is moved to another tier: ```markdown -> - [Introduced](<link-to-issue>) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.5. -> - [Moved](<link-to-issue>) to [GitLab Starter](https://about.gitlab.com/pricing/) in 11.8. -> - [Moved](<link-to-issue>) to GitLab Core in 12.0. +> - [Moved](<link-to-issue>) from [GitLab Premium](https://about.gitlab.com/pricing/) to [GitLab Starter](https://about.gitlab.com/pricing/) in 11.8. +> - [Moved](<link-to-issue>) from [GitLab Starter](https://about.gitlab.com/pricing/) to GitLab Core in 12.0. ``` If a feature is deprecated, include a link to a replacement (when available): @@ -1731,127 +1680,123 @@ If a feature is deprecated, include a link to a replacement (when available): > - [Deprecated](<link-to-issue>) in GitLab 11.3. Replaced by [meaningful text](<link-to-appropriate-documentation>). ``` -You can also describe the replacement in surrounding text, if available. - -If the deprecation is not obvious in existing text, you may want to include a -warning such as: +You can also describe the replacement in surrounding text, if available. If the +deprecation isn't obvious in existing text, you may want to include a warning: ```markdown -DANGER: **Deprecated:** -This feature was [deprecated](link-to-issue) in GitLab 12.3 -and replaced by [Feature name](link-to-feature-documentation). +WARNING: +This feature was [deprecated](link-to-issue) in GitLab 12.3 and replaced by +[Feature name](link-to-feature-documentation). ``` +In the first major GitLab version after the feature was deprecated, be sure to +remove information about that deprecated feature. + #### Inline version text If you're adding content to an existing topic, you can add version information inline with the existing text. In this case, add `([introduced/deprecated](<link-to-issue>) in GitLab X.X)`. -If applicable, include the paid tier: `([introduced/deprecated](<link-to-issue>) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.4)` Including the issue link is encouraged, but isn't a requirement. For example: ```markdown -The voting strategy (in GitLab 13.4 and later) requires -the primary and secondary voters to agree. +The voting strategy in GitLab 13.4 and later requires the primary and secondary +voters to agree. ``` #### End-of-life for features or products -Whenever a feature or product enters the end-of-life process, indicate its -status by using the `Danger` [alert](#alert-boxes) with the `**Important**` -keyword directly below the feature or product's header (which can include H1 -page titles). Link to the deprecation and removal issues, if possible. +When a feature or product enters its end-of-life, indicate its status by +creating a [warning alert](#alert-boxes) directly following its relevant header. +If possible, link to its deprecation and removal issues. For example: ```markdown -DANGER: **Important:** +WARNING: This feature is in its end-of-life process. It is [deprecated](link-to-issue) for use in GitLab X.X, and is planned for [removal](link-to-issue) in GitLab X.X. ``` +After the feature or product is officially deprecated and removed, remove +its information from the GitLab documentation. + ### Versions in the past or future When describing functionality available in past or future versions, use: -- _Earlier_, and not _older_ or _before_. -- _Later_, and not _newer_ or _after_. +- Earlier, and not older or before. +- Later, and not newer or after. For example: -- Available in GitLab 12.3 and earlier. +- Available in GitLab 13.1 and earlier. - Available in GitLab 12.4 and later. -- In GitLab 11.4 and earlier, ... -- In GitLab 10.6 and later, ... +- In GitLab 12.2 and earlier, ... +- In GitLab 11.6 and later, ... -### Importance of referencing GitLab versions and tiers +### Removing versions after each major release -Mentioning GitLab versions and tiers is important to all users and contributors -to quickly have access to the issue or merge request that introduced the change. -Also, they can know what features they have in their GitLab -instance and version, given that the note has some key information. +Whenever a major GitLab release occurs, we remove all version references +to now-unsupported versions of GitLab. Note that this includes the removal of +specific instructions for users of non-supported GitLab versions. For example, +if GitLab versions 11.x and later are supported, special +instructions for users of GitLab 10 should be removed. -`[Introduced](link-to-issue) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.7` -links to the issue that introduced the feature, says which GitLab tier it -belongs to, says the GitLab version that it became available in, and links to -the pricing page in case the user wants to upgrade to a paid tier to use that -feature. +To view historical information about a feature, review GitLab +[release posts](https://about.gitlab.com/releases/), or search for the issue or +merge request where the work was done. -For example, if you're a regular user and you're looking at the documentation -for a feature you haven't used before, you can immediately see if that feature -is available to you or not. Alternatively, if you've been using a certain -feature for a long time and it changed in some way, it's important to be able to -determine when it changed and what's new in that feature. +## Products and features -This is even more important as we don't have a perfect process for shipping -documentation. Unfortunately, we still see features without documentation, and -documentation without features. So, for now, we cannot rely 100% on the -documentation site versions. +Refer to the information in this section when describing products and features +in the GitLab product documentation. -Over time, version text will reference a progressively older version of GitLab. -In cases where version text refers to versions of GitLab four or more major -versions back, you can consider removing the text if it's irrelevant or confusing. +### Avoid line breaks in names -For example, if the current major version is 12.x, version text referencing -versions of GitLab 8.x and older are candidates for removal if necessary for -clearer or cleaner documentation. +If a feature or product name contains spaces, don't split the name with a line break. +When names change, it is more complicated to search or grep text that has line breaks. -## Products and features +### Product tier badges -Refer to the information in this section when describing products and features -within the GitLab product documentation. +Tier badges are displayed as orange text next to a heading. For example: -### Avoid line breaks in names + -When entering a product or feature name that includes a space (such as -GitLab Community Edition) or even other companies' products (such as -Amazon Web Services), be sure to not split the product or feature name across -lines with an inserted line break. Splitting product or feature names across -lines makes searching for these items more difficult, and can cause problems if -names change. +You must assign a tier badge: -For example, the following Markdown content is _not_ formatted correctly: +- To [all H1 topic headings](#product-tier-badges-on-headings). +- To topic headings that don't apply to the same tier as the H1. +- To [sections of a topic](#product-tier-badges-on-other-content), + if they apply to a tier other than what applies to the H1. -```markdown -When entering a product or feature name that includes a space (such as GitLab -Community Edition), don't split the product or feature name across lines. -``` +#### Product tier badges on headings -Instead, it should appear similar to the following: +To add a tier badge to a heading, add the relevant [tier badge](#available-product-tier-badges) +after the heading text. For example: ```markdown -When entering a product or feature name that includes a space (such as -GitLab Community Edition), don't split the product or feature name across lines. +# Heading title `**(CORE)**` ``` -### Product badges +#### Product tier badges on other content -When a feature is available in paid tiers, add the corresponding tier to the -header or other page element according to the feature's availability: +In paragraphs, list names, and table cells, an information icon displays when you +add a tier badge. More verbose information displays when a user points to the icon: + +- `**(STARTER)**` displays as **(STARTER)** +- `**(STARTER ONLY)**` displays as **(STARTER ONLY)** +- `**(SILVER ONLY)**` displays as **(SILVER ONLY)** + +The `**(STARTER)**` generates a `span` element to trigger the +badges and tooltips (`<span class="badge-trigger starter">`). When the keyword +_only_ is added, the corresponding GitLab.com badge isn't displayed. -| Tier in which feature is available | Tier markup | +#### Available product tier badges + +| Tier in which feature is available | Tier badge | |:-----------------------------------------------------------------------|:----------------------| | GitLab Core and GitLab.com Free, and their higher tiers | `**(CORE)**` | | GitLab Starter and GitLab.com Bronze, and their higher tiers | `**(STARTER)**` | @@ -1866,32 +1811,10 @@ header or other page element according to the feature's availability: | _Only_ GitLab.com Silver and higher tiers (no self-managed instances) | `**(SILVER ONLY)**` | | _Only_ GitLab.com Gold (no self-managed instances) | `**(GOLD ONLY)**` | -For clarity, all page title headers (H1s) must be have a tier markup for the -lowest tier that has information on the documentation page. - -If sections of a page apply to higher tier levels, they can be separately -labeled with their own tier markup. - -#### Product badge display behavior - -When using the tier markup with headers, the documentation page will display the -full tier badge with the header line. - -You can also use the tier markup with paragraphs, list items, and table cells. -For these cases, the tier mention will be represented by an orange info icon -**{information}** that will display the tiers when visitors point to the icon. -For example: - -- `**(STARTER)**` displays as **(STARTER)** -- `**(STARTER ONLY)**` displays as **(STARTER ONLY)** -- `**(SILVER ONLY)**` displays as **(SILVER ONLY)** - -#### How it works - -Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/244), -the special markup `**(STARTER)**` will generate a `span` element to trigger the -badges and tooltips (`<span class="badge-trigger starter">`). When the keyword -_only_ is added, the corresponding GitLab.com badge will not be displayed. +Topics that mention the `gitlab.rb` file are referring to +self-managed instances of GitLab. To prevent confusion, include the relevant `TIER ONLY` +tier badge on the highest applicable heading level on +the page. ## Specific sections @@ -1900,45 +1823,42 @@ sections are outlined in this section. ### GitLab restart -There are many cases that a restart/reconfigure of GitLab is required. To avoid -duplication, link to the special document that can be found in -[`doc/administration/restart_gitlab.md`](../../../administration/restart_gitlab.md). -Usually the text will read like: +When a restart or reconfigure of GitLab is required, avoid duplication by linking +to [`doc/administration/restart_gitlab.md`](../../../administration/restart_gitlab.md) +with text like this, replacing 'reconfigure' with 'restart' as needed: ```markdown Save the file and [reconfigure GitLab](../../../administration/restart_gitlab.md) for the changes to take effect. ``` -If the document you are editing resides in a place other than the GitLab CE/EE -`doc/` directory, instead of the relative link, use the full path: -`https://docs.gitlab.com/ee/administration/restart_gitlab.html`. Replace -`reconfigure` with `restart` where appropriate. +If the document resides outside of the `doc/` directory, use the full path +instead of the relative link: +`https://docs.gitlab.com/ee/administration/restart_gitlab.html`. ### Installation guide -**Ruby:** In [step 2 of the installation guide](../../../install/installation.md#2-ruby), -we install Ruby from source. Whenever there is a new version that needs to -be updated, remember to change it throughout the codeblock and also replace -the sha256sum (it can be found in the [downloads page](https://www.ruby-lang.org/en/downloads/) -of the Ruby website). +we install Ruby from source. To update the guide for a new Ruby version: -### Configuration documentation for source and Omnibus installations +- Change the version throughout the code block. +- Replace the sha256sum. It's available on the + [downloads page](https://www.ruby-lang.org/en/downloads/) of the Ruby website. -GitLab currently officially supports two installation methods: installations -from source and Omnibus packages installations. - -Whenever there's a setting that's configurable for both installation methods, -the preference is to document it in the CE documentation to avoid duplication. +### Configuration documentation for source and Omnibus installations -Configuration settings include: +GitLab supports two installation methods: installations from source, and Omnibus +packages. Possible configuration settings include: - Settings that touch configuration files in `config/`. -- NGINX settings and settings in `lib/support/` in general. +- NGINX settings. +- Other settings in `lib/support/`. -When you document a list of steps, it may entail editing the configuration file -and reconfiguring or restarting GitLab. In that case, use these styles: +Configuration procedures can require users to edit configuration files, reconfigure +GitLab, or restart GitLab. Use these styles to document these steps, replacing +`PATH/TO` with the appropriate path: + +<!-- vale off --> ````markdown **For Omnibus installations** @@ -1949,7 +1869,7 @@ and reconfiguring or restarting GitLab. In that case, use these styles: external_url "https://gitlab.example.com" ``` -1. Save the file and [reconfigure](path/to/administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure](PATH/TO/administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. --- @@ -1963,25 +1883,25 @@ and reconfiguring or restarting GitLab. In that case, use these styles: host: "gitlab.example.com" ``` -1. Save the file and [restart](path/to/administration/restart_gitlab.md#installations-from-source) +1. Save the file and [restart](PATH/TO/administration/restart_gitlab.md#installations-from-source) GitLab for the changes to take effect. ```` +<!-- vale on --> + In this case: -- Before each step list the installation method is declared in bold. -- Three dashes (`---`) are used to create a horizontal line and separate the two - methods. -- The code blocks are indented one or more spaces under the list item to render - correctly. -- Different highlighting languages are used for each config in the code block. -- The [GitLab Restart](#gitlab-restart) section is used to explain a required +- Bold the installation method's name. +- Separate the methods with three dashes (`---`) to create a horizontal line. +- Indent the code blocks to line up with the list item they belong to.. +- Use the appropriate syntax highlighting for each code block. +- Use the [GitLab Restart](#gitlab-restart) section to explain any required restart or reconfigure of GitLab. ### Troubleshooting -For troubleshooting sections, you should provide as much context as possible so -users can identify the problem they are facing and resolve it on their own. You +For troubleshooting sections, provide as much context as possible so +users can identify their problem and resolve it on their own. You can facilitate this by making sure the troubleshooting content addresses: 1. The problem the user needs to solve. @@ -1989,7 +1909,7 @@ can facilitate this by making sure the troubleshooting content addresses: 1. Steps the user can take towards resolution of the problem. If the contents of each category can be summarized in one line and a list of -steps aren't required, consider setting up a [table](#tables) with headers of +steps aren't required, consider setting up a [table](#tables). Create headers of _Problem_ \| _Cause_ \| _Solution_ (or _Workaround_ if the fix is temporary), or _Error message_ \| _Solution_. diff --git a/doc/development/documentation/testing.md b/doc/development/documentation/testing.md index 043da38d207..d2e3f473532 100644 --- a/doc/development/documentation/testing.md +++ b/doc/development/documentation/testing.md @@ -1,40 +1,46 @@ --- stage: none group: Documentation Guidelines -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: Learn how to contribute to GitLab Documentation. --- # Documentation testing -We treat documentation as code, and so use tests in our CI pipeline to maintain the -standards and quality of the docs. The current tests, which run in CI jobs when a -merge request with new or changed docs is submitted, are: - -- [`docs lint`](https://gitlab.com/gitlab-org/gitlab/-/blob/0b562014f7b71f98540e682c8d662275f0011f2f/.gitlab/ci/docs.gitlab-ci.yml#L41): - Runs several tests on the content of the docs themselves: - - [`lint-doc.sh` script](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/lint-doc.sh) - runs the following checks and linters: - - All cURL examples use the long flags (ex: `--header`, not `-H`). - - The `CHANGELOG.md` does not contain duplicate versions. - - No files in `doc/` are executable. - - No new `README.md` was added. - - [markdownlint](#markdownlint). - - [Vale](#vale). - - Nanoc tests: - - [`internal_links`](https://gitlab.com/gitlab-org/gitlab/-/blob/0b562014f7b71f98540e682c8d662275f0011f2f/.gitlab/ci/docs.gitlab-ci.yml#L58) - checks that all internal links (ex: `[link](../index.md)`) are valid. - - [`internal_anchors`](https://gitlab.com/gitlab-org/gitlab/-/blob/0b562014f7b71f98540e682c8d662275f0011f2f/.gitlab/ci/docs.gitlab-ci.yml#L60) - checks that all internal anchors (ex: `[link](../index.md#internal_anchor)`) - are valid. - - [`ui-docs-links lint`](https://gitlab.com/gitlab-org/gitlab/-/blob/0b562014f7b71f98540e682c8d662275f0011f2f/.gitlab/ci/docs.gitlab-ci.yml#L62) - checks that all links to docs from UI elements (`app/views` files, for example) - are linking to valid docs and anchors. +GitLab documentation is stored in projects with code and treated like code. Therefore, we use +processes similar to those used for code to maintain standards and quality of documentation. + +We have tests: + +- To lint the words and structure of the documentation. +- To check the validity of internal links within the documentation suite. +- To check the validity of links from UI elements, such as files in `app/views` files. + +For the specifics of each test run in our CI/CD pipelines, see the configuration for those tests +in the relevant projects: + +- <https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/ci/docs.gitlab-ci.yml> +- <https://gitlab.com/gitlab-org/gitlab-runner/-/blob/master/.gitlab/ci/docs.gitlab-ci.yml> +- <https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/master/gitlab-ci-config/gitlab-com.yml> +- <https://gitlab.com/gitlab-org/charts/gitlab/-/blob/master/.gitlab-ci.yml> ## Run tests locally -Apart from [previewing your changes locally](index.md#previewing-the-changes-live), you can also run all lint checks -and Nanoc tests locally. +Similar to [previewing your changes locally](index.md#previewing-the-changes-live), you can also +run these tests on your local computer. This has the advantage of: + +- Speeding up the feedback loop. You can know of any problems with the changes in your branch + without waiting for a CI/CD pipeline to run. +- Lowering costs. Running tests locally is cheaper than running tests on the cloud + infrastructure GitLab uses. + +To run tests locally, it's important to: + +- [Install the tools](#install-linters), and [keep them up to date](#update-linters). +- Run [linters](#lint-checks), [documentation link tests](#documentation-link-tests), and + [UI link tests](#ui-link-tests) the same way they are run in CI/CD pipelines. It's important to use + same configuration we use in CI/CD pipelines, which can be different than the default configuration + of the tool. ### Lint checks @@ -66,15 +72,15 @@ The output should be similar to: This requires you to either: -- Have the required lint tools installed on your machine. +- Have the [required lint tools installed](#local-linters) on your computer. - A working Docker installation, in which case an image with these tools pre-installed is used. -### Nanoc tests +### Documentation link tests -To execute Nanoc tests locally: +To execute documentation link tests locally: 1. Navigate to the [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) directory. -1. Run: +1. Run the following commands: ```shell # Check for broken internal links @@ -85,7 +91,7 @@ To execute Nanoc tests locally: bundle exec nanoc check internal_anchors ``` -### `ui-docs-links` test +### UI link tests The `ui-docs-links lint` job uses `haml-lint` to test that all links to docs from UI elements (`app/views` files, for example) are linking to valid docs and anchors. @@ -100,9 +106,9 @@ To run the `ui-docs-links` test locally: ``` If you receive an error the first time you run this test, run `bundle install`, which -installs GitLab's dependencies, and try again. +installs the dependencies for GitLab, and try again. -If you don't want to install all of GitLab's dependencies to test the links, you can: +If you don't want to install all of the dependencies to test the links, you can: 1. Open the `gitlab` directory in a terminal window. 1. Install `haml-lint`: @@ -186,27 +192,34 @@ You can use Vale: - [In a Git hook](#configure-pre-push-hooks). Vale only reports errors in the Git hook (the same configuration as the CI/CD pipelines), and does not report suggestions or warnings. -### Install linters +#### Vale result types -At a minimum, install [markdownlint](#markdownlint) and [Vale](#vale) to match the checks run in -build pipelines: +Vale returns three types of results: `suggestion`, `warning`, and `error`: -1. Install `markdownlint-cli`, using either: +- **Suggestion**-level results are writing tips and aren't displayed in CI + job output. Suggestions don't break CI. +- **Warning**-level results are [Style Guide](styleguide/index.md) violations, aren't displayed in CI + job output, and should contain clear explanations of how to resolve the warning. + Warnings may be technical debt, or can be future error-level test items + (after the Technical Writing team completes its cleanup). Warnings don't break CI. +- **Error**-level results are Style Guide violations, and should contain clear explanations + about how to resolve the error. Errors break CI and are displayed in CI job output. + of how to resolve the error. Errors break CI and are displayed in CI job output. - - `npm`: +### Install linters - ```shell - npm install -g markdownlint-cli - ``` +At a minimum, install [markdownlint](#markdownlint) and [Vale](#vale) to match the checks run in +build pipelines: - - `yarn`: +1. Install `markdownlint-cli`: - ```shell - yarn global add markdownlint-cli - ``` + ```shell + yarn global add markdownlint-cli + ``` - We recommend installing the version of `markdownlint-cli` currently used in the documentation - linting [Docker image](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/.gitlab-ci.yml#L420). + We recommend installing the version of `markdownlint-cli` + [used](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/.gitlab-ci.yml#L447) when building + the `image:docs-lint-markdown`. 1. Install [`vale`](https://github.com/errata-ai/vale/releases). For example, to install using `brew` for macOS, run: @@ -215,14 +228,29 @@ build pipelines: brew install vale ``` - We recommend installing the version of Vale currently used in the documentation linting - [Docker image](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/.gitlab-ci.yml#L419). +These tools can be [integrated with your code editor](#configure-editors). + +### Update linters + +It's important to use linter versions that are the same or newer than those run in +CI/CD. This provides access to new features and possible bug fixes. -In addition to using markdownlint and Vale at the command line, these tools can be -[integrated with your code editor](#configure-editors). +To match the versions of `markdownlint-cli` and `vale` used in the GitLab projects, refer to the +[versions used](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/.gitlab-ci.yml#L447) +when building the `image:docs-lint-markdown` Docker image containing these tools for CI/CD. + +| Tool | Version | Command | Additional information | +|--------------------|----------|-------------------------------------------|------------------------| +| `markdownlint-cli` | Latest | `yarn global add markdownlint-cli` | n/a | +| `markdownlint-cli` | Specfic | `yarn global add markdownlint-cli@0.23.2` | The `@` indicates a specific version, and this example updates the tool to version `0.23.2`. | +| Vale | Latest | `brew update && brew upgrade vale` | This command is for macOS only. | +| Vale | Specific | n/a | Not possible using `brew`, but can be [directly downloaded](https://github.com/errata-ai/vale/releases). | ### Configure editors +Using linters in your editor is more convenient than having to run the commands from the +command line. + To configure markdownlint within your editor, install one of the following as appropriate: - [Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint) diff --git a/doc/development/documentation/workflow.md b/doc/development/documentation/workflow.md index 9bc80116d25..e809ca84707 100644 --- a/doc/development/documentation/workflow.md +++ b/doc/development/documentation/workflow.md @@ -1,13 +1,13 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Documentation process The process for creating and maintaining GitLab product documentation allows -anyone to contribute a merge request or create an issue for GitLab's +anyone to contribute a merge request or create an issue for GitLab documentation. Documentation updates relating to new features or feature enhancements must @@ -60,9 +60,9 @@ To update GitLab documentation: - The [Structure and template](structure.md) page. - The [Style Guide](styleguide/index.md). - The [Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/). -1. Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). +1. Follow the [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). -TIP: **Tip:** +NOTE: Work in a fork if you do not have Developer access to the GitLab project. Request help from the Technical Writing team if you: @@ -79,7 +79,7 @@ To request help: - If urgent help is required, directly assign the Technical Writer in the issue or in the merge request. - If non-urgent help is required, ping the Technical Writer in the issue or merge request. -If you are a member of GitLab's Slack workspace, you can request help in `#docs`. +If you are a member of the GitLab Slack workspace, you can request help in `#docs`. ### Reviewing and merging @@ -146,7 +146,7 @@ Remember: advance of a milestone release and for larger documentation changes. - You can request a post-merge Technical Writer review of documentation if it's important to get the code with which it ships merged as soon as possible. In this case, the author of the original MR - will address the feedback provided by the Technical Writer in a follow-up MR. + can address the feedback provided by the Technical Writer in a follow-up MR. - The Technical Writer can also help decide that documentation can be merged without Technical writer review, with the review to occur soon after merge. @@ -154,8 +154,8 @@ Remember: Ensure the following if skipping an initial Technical Writer review: -- That [product badges](styleguide/index.md#product-badges) are applied. -- That the GitLab [version](styleguide/index.md#text-for-documentation-requiring-version-text) that +- That [product badges](styleguide/index.md#product-tier-badges) are applied. +- That the GitLab [version](styleguide/index.md#gitlab-versions) that introduced the feature has been included. - That changes to headings don't affect in-app hyperlinks. - Specific [user permissions](../../user/permissions.md) are documented. |
