Commit 7e23a4f7 authored by Amy Qualls's avatar Amy Qualls Committed by Suzanne Selhorn

Another round of style guide cleanup

More tinkering, and some judicious Vale disabling, to bring the
style guide page closer to GitLab tone and style.
parent 62b99717
...@@ -484,6 +484,7 @@ sudo ...@@ -484,6 +484,7 @@ sudo
swimlane swimlane
swimlanes swimlanes
syslog syslog
tanuki
tcpdump tcpdump
Thanos Thanos
Tiller Tiller
......
...@@ -533,7 +533,9 @@ tenses, words, and phrases: ...@@ -533,7 +533,9 @@ tenses, words, and phrases:
content is accessible to more readers. content is accessible to more readers.
- Don't write in the first person singular. - 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).) (Tested in [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).)
<!-- vale gitlab.FirstPerson = NO -->
- Instead of _I_ or _me_, use _we_, _you_, _us_, or _one_. - Instead of _I_ or _me_, use _we_, _you_, _us_, or _one_.
<!-- vale gitlab.FirstPerson = YES -->
- When possible, stay user focused by writing in the second person (_you_ or - When possible, stay user focused by writing in the second person (_you_ or
the imperative). the imperative).
- Don't overuse "that". In many cases, you can remove "that" from a sentence - Don't overuse "that". In many cases, you can remove "that" from a sentence
...@@ -795,6 +797,8 @@ Items nested in lists should always align with the first character of the list ...@@ -795,6 +797,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 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
...@@ -816,8 +820,12 @@ indentation: ...@@ -816,8 +820,12 @@ 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
...@@ -839,6 +847,8 @@ For ordered lists, use three spaces for each level of indentation: ...@@ -839,6 +847,8 @@ 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:
...@@ -904,7 +914,7 @@ Valid for Markdown content only, not for front matter entries: ...@@ -904,7 +914,7 @@ Valid for Markdown content only, not for front matter entries:
- Standard quotes: double quotes (`"`). Example: "This is wrapped in double - Standard quotes: double quotes (`"`). Example: "This is wrapped in double
quotes". quotes".
- Quote inside a quote: double quotes (`"`) wrap single quotes (`'`). Example: - Quote inside a quote: double quotes (`"`) wrap single quotes (`'`). Example:
"I am 'quoting' something in a quote". "This sentence 'quotes' something in a quote".
For other punctuation rules, refer to the For other punctuation rules, refer to the
[GitLab UX guide](https://design.gitlab.com/content/punctuation/). [GitLab UX guide](https://design.gitlab.com/content/punctuation/).
...@@ -1367,6 +1377,8 @@ hidden on the documentation site, but is displayed by `/help`. ...@@ -1367,6 +1377,8 @@ 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
...@@ -1385,6 +1397,8 @@ hidden on the documentation site, but is displayed by `/help`. ...@@ -1385,6 +1397,8 @@ 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 the following table for the most common language classes, 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) or check the [complete list](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers)
...@@ -1771,8 +1785,7 @@ for use in GitLab X.X, and is planned for [removal](link-to-issue) in GitLab X.X ...@@ -1771,8 +1785,7 @@ 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 After the feature or product is officially deprecated and removed, remove
its information from the GitLab documentation based on its information from the GitLab documentation.
the GitLab version where it's actually removed.
### Versions in the past or future ### Versions in the past or future
...@@ -1926,6 +1939,8 @@ Configuration settings include: ...@@ -1926,6 +1939,8 @@ Configuration settings include:
When you document a list of steps, it may entail editing the configuration file 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: and reconfiguring or restarting GitLab. In that case, use these styles:
<!-- vale off -->
````markdown ````markdown
**For Omnibus installations** **For Omnibus installations**
...@@ -1953,6 +1968,8 @@ and reconfiguring or restarting GitLab. In that case, use these styles: ...@@ -1953,6 +1968,8 @@ and reconfiguring or restarting GitLab. In that case, use these styles:
GitLab for the changes to take effect. GitLab for the changes to take effect.
```` ````
<!-- vale on -->
In this case: In this case:
- Before each step list the installation method is declared in bold. - Before each step list the installation method is declared in bold.
......
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