diff options
| author | Marcel Amirault <mamirault@gitlab.com> | 2019-07-19 05:20:32 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-07-19 05:20:32 +0300 |
| commit | 7da80b2d36adc30964423042e956ef880a2650f9 (patch) | |
| tree | 81c5e21931e2d2134fbedb8c0a859aeac6d14c5b /doc/user | |
| parent | acdb1f79688adae87933b34c3140e286ebab055c (diff) | |
Update numbered lists for docs standards
Ensure that all numbered lists use only 1. and no other numbers.
Also ensure that numbered lists use proper spacing.
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/application_security/index.md | 6 | ||||
| -rw-r--r-- | doc/user/application_security/security_dashboard/index.md | 4 | ||||
| -rw-r--r-- | doc/user/markdown.md | 14 |
3 files changed, 13 insertions, 11 deletions
diff --git a/doc/user/application_security/index.md b/doc/user/application_security/index.md index 91e79f6c23b..56a4cbd26d2 100644 --- a/doc/user/application_security/index.md +++ b/doc/user/application_security/index.md @@ -115,9 +115,9 @@ generated by GitLab. To apply the fix: 1. Click on the vulnerability. 1. Download and review the patch file `remediation.patch`. -2. Ensure your local project has the same commit checked out that was used to generate the patch. -3. Run `git apply remediation.patch`. -4. Verify and commit the changes to your branch. +1. Ensure your local project has the same commit checked out that was used to generate the patch. +1. Run `git apply remediation.patch`. +1. Verify and commit the changes to your branch.  diff --git a/doc/user/application_security/security_dashboard/index.md b/doc/user/application_security/security_dashboard/index.md index 3b01fe66e03..2a2385c00ae 100644 --- a/doc/user/application_security/security_dashboard/index.md +++ b/doc/user/application_security/security_dashboard/index.md @@ -26,8 +26,8 @@ To use the project or group security dashboard: 1. At least one project inside a group must be configured with at least one of the [supported reports](#supported-reports). -2. The configured jobs must use the [new `reports` syntax](../../../ci/yaml/README.md#artifactsreports). -3. [GitLab Runner](https://docs.gitlab.com/runner/) 11.5 or newer must be used. +1. The configured jobs must use the [new `reports` syntax](../../../ci/yaml/README.md#artifactsreports). +1. [GitLab Runner](https://docs.gitlab.com/runner/) 11.5 or newer must be used. If you're using the shared Runners on GitLab.com, this is already the case. ## Project Security Dashboard diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 96e74125801..37f3f21f539 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -1160,13 +1160,15 @@ Examples: + Or pluses ``` +<!-- The "2." and "4." in the example above are changed to "1." below, only to match the standards on docs.gitlab.com --> + 1. First ordered list item -2. Another item +1. Another item - Unordered sub-list. 1. Actual numbers don't matter, just that it's a number 1. Ordered sub-list 1. Next ordered sub-list item -4. And another item. +1. And another item. * Unordered lists can use asterisks - Or minuses @@ -1184,14 +1186,14 @@ Example: Second paragraph of first item. -2. Another item +1. Another item ``` 1. First ordered list item Second paragraph of first item. -2. Another item +1. Another item --- @@ -1205,14 +1207,14 @@ Example: Paragraph of first item. -2. Another item +1. Another item ``` 1. First ordered list item Paragraph of first item. -2. Another item +1. Another item ### Superscripts / Subscripts |