-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
39 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
; Vale configuration file to test the `ProductCentricWriting` rule | ||
StylesPath = ../../../styles | ||
MinAlertLevel = suggestion | ||
[*.adoc] | ||
RedHat.ProductCentricWriting = YES |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
OpenShift allows customers to use a Kubernetes Network Policy to create microsegmentation between deployed application services on the cluster. | ||
The `monitoring-rules-edit` rule permits you to create and silence alerts in the *Developer* perspective in the web console. | ||
The `must-gather` tool enables the user to collect diagnostic information about your cluster. | ||
LoadBalancer lets users assign an external load balancer to an associated service API object in your {product-title} cluster. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
extends: substitution | ||
ignorecase: true | ||
level: suggestion | ||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/productcentricwriting/ | ||
message: "%s" | ||
swap: | ||
# Start each error message with "Do not use ..." | ||
# Error messages must be single quoted. | ||
'allows(?: you| customers| the customer| the user| users)': 'Do not use "allows" to grant abilities to inanimate objects, as in "the product allows you to…". Whenever possible, use a direct, user-focused alternative.' | ||
'enables(?: you| customers| the customer| the user| users)': 'Do not use "enables" to grant abilities to inanimate objects, as in "the product enables you to…". Whenever possible, use a direct, user-focused alternative.' | ||
'lets(?: you| customers| the customer| the user| users)': 'Do not use "lets" to grant abilities to inanimate objects, as in "the product lets you…". Whenever possible, use a direct, user-focused alternative.' | ||
'permits(?: you| customers| the customer| the user| users)': 'Do not use "permits" to grant abilities to inanimate objects, unless the object is a type of authorization that does grant abilities.' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
:navtitle: PassiveVoice | ||
:navtitle: Passive voice | ||
:keywords: reference, rule, PassiveVoice | ||
|
||
= Passive Voice | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
:navtitle: Product-centric writing | ||
:keywords: product-centric, writing | ||
|
||
= Product-centric writing | ||
|
||
Do not use product-centric writing to grant abilities to inanimate objects. Where possible, make the user the subject of the sentence. | ||
|
||
.Additional resources | ||
|
||
* link:{ibmsg-url-print}[{ibmsg-print} - Conversational style, p. 19] | ||
* link:{ibmsg-url}?topic=medium-conversational-style[{ibmsg} - Conversational style] |