Skip to content

Commit

Permalink
Merge branch 'main' into DOCS-982/document-obstacles_depth-model
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre authored Sep 11, 2023
2 parents 7a085d0 + a84d4d9 commit 0242478
Show file tree
Hide file tree
Showing 187 changed files with 2,039 additions and 976 deletions.
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AbbreviationsPeriods.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Based on: https://github.com/errata-ai/Google/blob/master/Google/Periods.yml
extends: existence
message: "Don't use periods with acronyms or initialisms such as '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/abbreviations'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/abbreviations.rst'
level: warning
nonword: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Adverbs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "You can remove most adverbs. Use your best judgment."
link: 'https://docs.rackspace.com/docs/style-guide/writing/write-clear-concise-sentences-paragraphs/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/write-clear-concise-sentences-paragraphs.rst'
level: suggestion
ignorecase: true
scope: sentence
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Antecedents.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Avoid using the antecedent '%s' at the beginning of sentences or clauses."
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-pronouns-carefully/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-pronouns-carefully.rst'
level: suggestion
ignorecase: false
scope: sentence
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Avoid.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Don't use '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/alphabetical-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/alphabetical-terms.rst'
ignorecase: true
level: warning
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidAccessible.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Use accessible only to refer to things that all people, including those with disabilities, can easily use. Don’t use it to mean simple or open."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/alphabetical-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/alphabetical-terms.rst'
level: warning
ignorecase: false
nonword: false
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidFirstPerson.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

extends: existence
message: "Avoid first-person pronouns such as '%s' where possible."
link: 'https://docs.rackspace.com/docs/style-guide/writing/write-to-the-user/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/write-to-the-user.rst'
ignorecase: true
level: warning
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidFutureTense.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ extends: existence
message: 'Avoid using future tense where possible.'
ignorecase: true
level: warning
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-present-tense/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-present-tense.rst'
raw:
- "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
- "will( |\n|[[:punct:]])[a-zA-Z]*|"
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidObscure.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/general-term-guidelines/avoid-obscure-words'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/general-term-guidelines/avoid-obscure-words.rst'
level: error
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidPastTense.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: 'Avoid using past tense where possible: "%s".'
ignorecase: true
level: warning
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-present-tense/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-present-tense.rst'
scope: sentence
tokens:
- abode
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidSubjunctive.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Avoid the subjuntive '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/writing/write-to-the-user/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/write-to-the-user.rst'
ignorecase: true
level: warning
scope: sentence
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidSupported.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: existence
message: "Avoid making claims as to supported software unless we are
tracking how this software evolves."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/alphabetical-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/alphabetical-terms.rst'
level: suggestion
ignorecase: false
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/AvoidWithSubstitution.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Consider if '%s' makes sense instead of '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/alphabetical-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/alphabetical-terms.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Careful.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Verify your usage of '%s' with the Alphabetical List of Terms in the style guide."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/alphabetical-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/alphabetical-terms.rst'
level: suggestion
ignorecase: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/CommaOxford.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

extends: existence
message: "Use the Oxford comma in '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/punctuation#commas'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/punctuation#commas.rst'
level: suggestion
nonword: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/CommaQuotation.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "When a comma is required after a quotation that’s embedded in text, place the comma inside the closing quotation mark."
link: 'https://docs.rackspace.com/docs/style-guide/style/punctuation#commas'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/punctuation#commas.rst'
level: error
scope: text
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/CommaRestrictiveClause.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Don’t use a comma to set off a restrictive clause (one that begins with that)."
link: 'https://docs.rackspace.com/docs/style-guide/style/punctuation#commas'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/punctuation#commas.rst'
ignorecase: true
level: suggestion
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/ConciseTerms.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "'%s' is preferred over '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/concise-terms#concise-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/concise-terms#concise-terms.rst'
level: suggestion
ignorecase: false
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/ConsistencyEarlierLater.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "To refer to product releases, use earlier or later."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/general-term-guidelines/use-consistent-time-references'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/general-term-guidelines/use-consistent-time-references.rst'
nonword: false
level: suggestion
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/ConsistencyFollowingPreceding.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "If you can't use specific references, use following or preceding to reference an item in text or copy."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/general-term-guidelines/use-consistent-time-references'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/general-term-guidelines/use-consistent-time-references.rst'
nonword: false
level: suggestion
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Contractions.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Feel free to use '%s' instead of '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/contractions'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/contractions.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/ContractionsNegative.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: substitution
message: "Feel free to use '%s' instead of '%s', unless you mean to
emphasize the negative."
link: 'https://docs.rackspace.com/docs/style-guide/style/contractions'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/contractions.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Dashes.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Based on: https://github.com/errata-ai/Google/blob/master/Google/EnDash.yml
extends: existence
message: "Use an em dash ('—') instead of '–' unless this is a compound word."
link: 'https://docs.rackspace.com/docs/style-guide/style/punctuation#dashes'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/punctuation#dashes.rst'
nonword: true
level: suggestion
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/DashesSpaces.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Based on: https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Dashes.yml
extends: existence
message: "Remove whitespace around '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/punctuation#dashes'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/punctuation#dashes.rst'
ignorecase: true
scope: sentence
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Dates.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Based on: https://github.com/errata-ai/Microsoft/blob/master/Microsoft/DateFormat.yml
extends: existence
message: "Unless space is limited, use 'November 12, 2010' format, not '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/dates'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/dates.rst'
ignorecase: true
level: error
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/DatesCommaMDY.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Use a comma before and after the year '%s' when the month, day, and year are embedded in a sentence."
link: 'https://docs.rackspace.com/docs/style-guide/style/dates'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/dates.rst'
ignorecase: true
level: error
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/DatesCommaMY.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: "Do not use a comma before and after the year '%s' when only
the month and year are embedded in a sentence unless the syntax would
ordinarily require a comma following the year."
link: 'https://docs.rackspace.com/docs/style-guide/style/dates'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/dates.rst'
ignorecase: true
level: warning
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/DatesOrdinal.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Spell out all ordinal numbers ('%s'). For example, don’t use January 1st; use January 1 instead."
link: 'https://docs.rackspace.com/docs/style-guide/style/dates'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/dates.rst'
level: error
nonword: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/DomainNames.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: conditional
message: "Use *.example.com or *.example.org in example domain names
instead of '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/email-addresses'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/email-addresses.rst'
level: suggestion
ignorecase: false
# This is a hack to allow us to make use of exceptions.
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Email.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: conditional
message: "Use @example.com or @example.org as the domain name for example
email addresses instead of '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/email-addresses'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/email-addresses.rst'
level: suggestion
ignorecase: false
# This is a hack to allow us to make use of exceptions.
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/GlobalAudienceIdioms.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Use '%s' instead of the idiom/colloquialism '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/terms-for-global-audience#don-t-use-idioms-or-colloquialisms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/terms-for-global-audience#don-t-use-idioms-or-colloquialisms.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/GlobalAudienceJargon.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Consider using '%s' instead of the jargon '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/terms-for-global-audience#use-jargon-carefully'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/terms-for-global-audience#use-jargon-carefully.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/GlobalAudienceMetaphorical.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Use '%s' instead of the metaphor '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/terminology/terms-for-global-audience#avoid-metaphorical-terms'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/terminology/terms-for-global-audience#avoid-metaphorical-terms.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/IPAdresses.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: conditional
message: "If you need to show an example IP address like '%s', don’t use one that is or might be assigned to an actual host. Use an address that’s globally defined for documentation."
link: 'https://docs.rackspace.com/docs/style-guide/style/ip-addresses'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/ip-addresses.rst'
level: suggestion
ignorecase: false
# This is a hack to allow us to make use of exceptions.
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/IPv4.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "IPv4 addresses should use periods (.) as separators ('%s')."
link: 'https://docs.rackspace.com/docs/style-guide/style/ip-addresses'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/ip-addresses.rst'
level: error
nonword: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/IPv6.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "IPv6 addresses should use colons (:) as separators ('%s')."
link: 'https://docs.rackspace.com/docs/style-guide/style/ip-addresses'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/ip-addresses.rst'
level: error
nonword: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Interjections.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

extends: existence
message: "Use interjections with care."
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-interjections-with-care/'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-interjections-with-care.rst'
nonword: true
level: warning
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/NegativeWords.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Use '%s' instead of the negative word '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-positive-statements'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-positive-statements.rst'
level: warning
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/NoContractions.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Use %s instead of the contraction '%s' to avoid confustion."
link: 'https://docs.rackspace.com/docs/style-guide/style/contractions'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/contractions.rst'
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Numbers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: "Spell out numbers like '%s' from zero through nine unless the numers are
as displayed or need to be input, are followed by a unit, or indicate
dimensions or time."
link: 'https://docs.rackspace.com/docs/style-guide/style/numbers'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/numbers.rst'
ignorecase: true
scope: sentence
level: suggestion
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/NumbersCommas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: "Use commas in '%s' unless it is an address, a fractional part of
a decimal number, a page number, or a literal representation of a
user-entered or displayed value."
link: 'https://docs.rackspace.com/docs/style-guide/style/numbers'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/numbers.rst'
ignorecase: true
level: suggestion
scope: sentence
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/NumbersRanges.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: existence
message: "Unless space is limited use either 'from 10 to 20 diagrams' or
'between 2010 and 2020' instead of '%s'."
link: 'https://docs.rackspace.com/docs/style-guide/style/numbers'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/numbers.rst'
ignorecase: true
level: warning
scope: sentence
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/NumbersThrough.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Don’t use the word inclusive in your description ('%s')."
link: 'https://docs.rackspace.com/docs/style-guide/style/numbers'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/numbers.rst'
ignorecase: true
level: warning
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/PhoneNumbers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: "Use a space, not a dash or parentheses, to separate parts of the
telephone number. Precede phone numbers with the applicable country code
('%s')."
link: 'https://docs.rackspace.com/docs/style-guide/style/telephone-numbers'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/telephone-numbers.rst'
nonword: true
level: suggestion
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/PluralsPossibility.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ indicate the possibility of more than one item, and don’t combine the
singular and plural forms of a verb, such as is/are. Use the singular
form or the plural form, use both forms joined by a conjunction, or use
the phrase one or more."
link: 'https://docs.rackspace.com/docs/style-guide/style/plurals'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/style/plurals.rst'
ignorecase: false
level: error
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/PositiveStatements.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Avoid negative statements where possible ('%s')."
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-positive-statements'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-positive-statements.rst'
ignorecase: true
level: suggestion
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/Semicolons.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Avoid using semicolons, which are often misused and, even when used correctly, can make sentences longer and more difficult to understand."
link: 'https://docs.rackspace.com/docs/style-guide/writing/use-correct-punctuation'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/use-correct-punctuation.rst'
nonword: true
level: suggestion
tokens:
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Viam/SentenceLength.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: occurrence
message: "Try to keep sentences short (< 25 words)."
link: 'https://docs.rackspace.com/docs/style-guide/writing/write-clear-concise-sentences-paragraphs'
link: 'https://github.com/rackerlabs/docs-style-guide/blob/master/style-guide/writing/write-clear-concise-sentences-paragraphs.rst'
scope: sentence
level: suggestion
max: 25
Expand Down
Loading

0 comments on commit 0242478

Please sign in to comment.