Commit 89f8c85b authored by Amy Qualls's avatar Amy Qualls

Merge branch 'docs-vale-exclusions' into 'master'

Removing some vale exclusions

See merge request gitlab-org/gitlab!53725
parents 85d78b5d f26ff54f
...@@ -35,14 +35,12 @@ To request access to ChatOps on GitLab.com: ...@@ -35,14 +35,12 @@ To request access to ChatOps on GitLab.com:
in the `#chat-ops-test` Slack channel, replacing `<username>` with your username: in the `#chat-ops-test` Slack channel, replacing `<username>` with your username:
`/chatops run member add <username> gitlab-com/chatops --ops` `/chatops run member add <username> gitlab-com/chatops --ops`
<!-- vale gitlab.FirstPerson = NO --> ```plaintext
Hi <__BUDDY_HANDLE__> and <__MANAGER_HANDLE__>, could you please add me to
> Hi `__BUDDY_HANDLE__` and `__MANAGER_HANDLE__`, could you please add me to the ChatOps project in Ops by running this command:
> the ChatOps project in Ops by running this command: `/chatops run member add <username> gitlab-com/chatops --ops` in the
> `/chatops run member add <username> gitlab-com/chatops --ops` in the `#chat-ops-test` Slack channel? Thanks in advance.
> `#chat-ops-test` Slack channel? Thanks in advance. ```
<!-- vale gitlab.FirstPerson = YES -->
1. Ensure you've set up two-factor authentication. 1. Ensure you've set up two-factor authentication.
1. After you're added to the ChatOps project, run this command to check your user 1. After you're added to the ChatOps project, run this command to check your user
......
...@@ -283,10 +283,7 @@ first time. ...@@ -283,10 +283,7 @@ first time.
you forget to remove any debugging code? you forget to remove any debugging code?
- Consider providing instructions on how to test the merge request. This can be - Consider providing instructions on how to test the merge request. This can be
helpful for reviewers not familiar with the product feature or area of the codebase. helpful for reviewers not familiar with the product feature or area of the codebase.
<!-- vale gitlab.FutureTense = NO --> - Be grateful for the reviewer's suggestions. (`Good call. I'll make that change.`)
- Be grateful for the reviewer's suggestions. ("Good call. I'll make that
change.")
<!-- vale gitlab.FutureTense = YES -->
- Don't take it personally. The review is of the code, not of you. - Don't take it personally. The review is of the code, not of you.
- Explain why the code exists. ("It's like that because of these reasons. Would - Explain why the code exists. ("It's like that because of these reasons. Would
it be more clear if I rename this class/file/method/variable?") it be more clear if I rename this class/file/method/variable?")
......
...@@ -742,8 +742,6 @@ Items nested in lists should always align with the first character of the list ...@@ -742,8 +742,6 @@ 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 item. In unordered lists (using `-`), this means two spaces for each level of
indentation: indentation:
<!-- vale off -->
````markdown ````markdown
- Unordered list item 1 - Unordered list item 1
...@@ -765,12 +763,8 @@ indentation: ...@@ -765,12 +763,8 @@ indentation:
![an image that will nest inside list item 4](image.png) ![an image that will nest inside list item 4](image.png)
```` ````
<!-- vale on -->
For ordered lists, use three spaces for each level of indentation: For ordered lists, use three spaces for each level of indentation:
<!-- vale off -->
````markdown ````markdown
1. Ordered list item 1 1. Ordered list item 1
...@@ -792,8 +786,6 @@ For ordered lists, use three spaces for each level of indentation: ...@@ -792,8 +786,6 @@ For ordered lists, use three spaces for each level of indentation:
![an image that will nest inside list item 4](image.png) ![an image that will nest inside list item 4](image.png)
```` ````
<!-- vale on -->
You can nest full lists inside other lists using the same rules as above. If you 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 want to mix types, that's also possible, if you don't mix items at the same
level: level:
...@@ -1324,8 +1316,6 @@ hidden on the documentation site, but is displayed by `/help`. ...@@ -1324,8 +1316,6 @@ hidden on the documentation site, but is displayed by `/help`.
- For regular fenced code blocks, always use a highlighting class corresponding to - For regular fenced code blocks, always use a highlighting class corresponding to
the language for better readability. Examples: the language for better readability. Examples:
<!-- vale off -->
````markdown ````markdown
```ruby ```ruby
Ruby code Ruby code
...@@ -1344,8 +1334,6 @@ hidden on the documentation site, but is displayed by `/help`. ...@@ -1344,8 +1334,6 @@ hidden on the documentation site, but is displayed by `/help`.
``` ```
```` ````
<!-- vale on -->
Syntax highlighting is required for fenced code blocks added to the GitLab Syntax highlighting is required for fenced code blocks added to the GitLab
documentation. Refer to this table for the most common language classes, documentation. Refer to this 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) or check the [complete list](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers)
...@@ -1834,8 +1822,6 @@ Configuration procedures can require users to edit configuration files, reconfig ...@@ -1834,8 +1822,6 @@ Configuration procedures can require users to edit configuration files, reconfig
GitLab, or restart GitLab. Use these styles to document these steps, replacing GitLab, or restart GitLab. Use these styles to document these steps, replacing
`PATH/TO` with the appropriate path: `PATH/TO` with the appropriate path:
<!-- vale off -->
````markdown ````markdown
**For Omnibus installations** **For Omnibus installations**
...@@ -1863,8 +1849,6 @@ GitLab, or restart GitLab. Use these styles to document these steps, replacing ...@@ -1863,8 +1849,6 @@ GitLab, or restart GitLab. Use these styles to document these steps, replacing
GitLab for the changes to take effect. GitLab for the changes to take effect.
```` ````
<!-- vale on -->
In this case: In this case:
- Bold the installation method's name. - Bold the installation method's name.
......
...@@ -26,15 +26,11 @@ To use a sprite Icon in HAML or Rails we use a specific helper function: ...@@ -26,15 +26,11 @@ To use a sprite Icon in HAML or Rails we use a specific helper function:
sprite_icon(icon_name, size: nil, css_class: '') sprite_icon(icon_name, size: nil, css_class: '')
``` ```
<!-- vale gitlab.Spelling = NO --> - **`icon_name`**: Use the `icon_name` for the SVG sprite in the list of
- **icon_name**: Use the icon_name for the SVG sprite in the list of
([GitLab SVGs](https://gitlab-org.gitlab.io/gitlab-svgs)). ([GitLab SVGs](https://gitlab-org.gitlab.io/gitlab-svgs)).
- **size (optional)**: Use one of the following sizes : 16, 24, 32, 48, 72 (this - **`size` (optional)**: Use one of the following sizes : 16, 24, 32, 48, 72 (this
is translated into a `s16` class) is translated into a `s16` class)
- **css_class (optional)**: If you want to add additional CSS classes. - **`css_class` (optional)**: If you want to add additional CSS classes.
<!-- vale gitlab.Spelling = YES -->
**Example** **Example**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment