Commit edf302a7 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'axil-yet-word-list' into 'master'

Add yet to the docs word list to avoid

See merge request gitlab-org/gitlab!81157
parents f448db60 903c3554
...@@ -5,9 +5,10 @@ ...@@ -5,9 +5,10 @@
# #
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence extends: existence
message: 'Avoid words like "%s" that promise future changes, because documentation is about the current state of the product.' message: 'Avoid words like "%s" when you write about future features. Our documentation is about the current state of the product.'
level: suggestion level: suggestion
ignorecase: true ignorecase: true
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list link: https://docs.gitlab.com/ee/development/documentation/styleguide/#promising-features-in-future-versions
tokens: tokens:
- currently - currently
- yet
...@@ -951,6 +951,17 @@ One exception: You can use **we recommend** instead of **it is recommended** or ...@@ -951,6 +951,17 @@ One exception: You can use **we recommend** instead of **it is recommended** or
Do not use **whitelist**. Another option is **allowlist**. ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml)) Do not use **whitelist**. Another option is **allowlist**. ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml))
## yet
Do not use **yet** when talking about the product or its features. The documentation describes the product as it is today.
Sometimes you might need to use **yet** when writing a task. If you use
**yet**, ensure the surrounding phrases are written
in present tense, active voice.
[View guidance about how to write about future features](index.md#promising-features-in-future-versions).
([Vale](../testing.md#vale) rule: [`CurrentStatus.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/CurrentStatus.yml))
## you, your, yours ## you, your, yours
Use **you**, **your**, and **yours** instead of [**the user** and **the user's**](#user-users). Use **you**, **your**, and **yours** instead of [**the user** and **the user's**](#user-users).
......
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