diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-26 09:09:02 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-26 09:09:02 +0000 |
| commit | d79bf171e4bcbb551a8320211ee337368b4d114c (patch) | |
| tree | 63f4305ee043eb6ca4b6f2113d8067b388b68ed8 /doc/development/documentation/styleguide/index.md | |
| parent | 6723a4288d29b11beec2de92fb7cfd682c9dcc50 (diff) | |
| download | gitlab-ce-d79bf171e4bcbb551a8320211ee337368b4d114c.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide/index.md')
| -rw-r--r-- | doc/development/documentation/styleguide/index.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 1af0cb72055..11625e466ff 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -950,6 +950,16 @@ For example: 1. Optional. Enter a description for the job. ``` +### Recommended steps + +If a step is recommended, start the step with the word `Recommended` followed by a period. + +For example: + +```markdown +1. Recommended. Enter a description for the job. +``` + ### Documenting multiple fields at once If the UI text sufficiently explains the fields in a section, do not include a task step for every field. |