mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
ENGDOCS-2176 (#20569)
This commit is contained in:
1
.github/vale/Docker/RecommendedWords.yml
vendored
1
.github/vale/Docker/RecommendedWords.yml
vendored
@@ -31,7 +31,6 @@ swap:
|
||||
check box: checkbox
|
||||
check boxes: checkboxes
|
||||
click: select
|
||||
deselect: clear
|
||||
ergo: therefore
|
||||
file name: filename
|
||||
keypress: keystroke
|
||||
|
||||
@@ -172,7 +172,3 @@ Avoid the use of exclamation marks.
|
||||
### Parentheses
|
||||
|
||||
Don't use parentheses in technical documentation. They can reduce the readability of a sentence.
|
||||
|
||||
## Third party documentation
|
||||
|
||||
If you are documenting a task that requires the use of a third-party product, link out to the third-party's documentation. Don't copy the content because it might violate copyright. It can also result in an unnecessary maintenance burden of having to keep the docs up-to-date when the third-party changes or updates their product. It is best practice to link to the single source of truth.
|
||||
|
||||
@@ -58,10 +58,6 @@ Select applies to more devices, while click is more specific to a mouse.
|
||||
|
||||
Don't use `currently` when talking about the product or its features. The documentation describes the product as it is today.
|
||||
|
||||
#### deselect
|
||||
|
||||
Don’t use `deselect`. Instead, use `clear`.
|
||||
|
||||
#### disable
|
||||
|
||||
Don't use `disable`. Implies that disability is a less-desired or negative state.
|
||||
|
||||
Reference in New Issue
Block a user