RedHat

Getting started

Add it to your .vale.ini, then run vale sync.

Packages = RedHat

[*.md]
BasedOnStyles = Vale, RedHat

• RedHat.Abbreviations error existence Style guide

  Do not use periods in all-uppercase abbreviations such as '%s'.

• RedHat.CaseSensitiveTerms warning substitution Style guide

  Use '%s' rather than '%s'.

• RedHat.Conjunctions suggestion existence scope: paragraph Style guide

  Do not overuse beginning sentences with '%s'.

• RedHat.ConsciousLanguage warning substitution Style guide

  Use %s rather than '%s'.

• RedHat.Contractions suggestion substitution Style guide

  Avoid contractions. Use '%s' rather than '%s.'

• RedHat.Definitions suggestion conditional Style guide

  Define acronyms and abbreviations (such as '%s') on first occurrence if they're likely to be unfamiliar.

• RedHat.DoNotUseTerms warning substitution Style guide

  %s

• RedHat.Ellipses suggestion existence Style guide

  Avoid the ellipsis (...) except to indicate omitted words.

• RedHat.EmDash warning existence scope: raw Style guide

  Do not use em dashes. Use punctuation marks such as commas, parentheses, or colons instead.

• RedHat.GitLinks warning existence scope: raw

  Do not include a link to %s unless it is explicitly approved.

• RedHat.HeadingPunctuation warning existence scope: heading Style guide

  Do not use end punctuation in headings.

• RedHat.Headings suggestion capitalization scope: heading Style guide

  Use sentence-style capitalization in '%s'.

• RedHat.Hyphens warning substitution Style guide

  Use %s rather than '%s'.

• RedHat.MergeConflictMarkers error existence scope: raw Style guide

  Do not commit Git merge conflict markers in source code.

• RedHat.NoGerundsInTitles suggestion existence scope: heading

  Where possible, avoid using gerunds in topic titles. Use the imperative form instead.

• RedHat.ObviousTerms suggestion existence scope: sentence

  Consider not documenting %s because it is self-explanatory.

• RedHat.OxfordComma suggestion existence scope: sentence Style guide

  Use the Oxford comma in '%s'.

• RedHat.PascalCamelCase suggestion existence scope: list, sentence Style guide

  Consider wrapping this Pascal or Camel case term ('%s') in backticks.

• RedHat.PassiveVoice suggestion existence Style guide

  '%s' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

• RedHat.ProductCentricWriting suggestion existence Style guide

  Do not use transitive verb constructions like '%s' to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action.

• RedHat.ReadabilityGrade suggestion readability Style guide

  Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9.

• RedHat.ReleaseNotes suggestion substitution Style guide

  For release notes, consider using '%s' rather than '%s'.

• RedHat.RepeatedWords warning repetition Style guide

  '%s' is repeated.

• RedHat.SelfReferentialText suggestion existence Style guide

  Avoid using self-referential text such as '%s'.

• RedHat.SentenceLength suggestion occurrence scope: sentence Style guide

  Try to keep sentences to an average of 32 words or fewer.

• RedHat.SessionId error existence scope: raw

  Do not publish URLs that contain session identifiers. Exposed session IDs enable session hijacking and unauthorized account access.

• RedHat.SimpleWords suggestion substitution Style guide

  Use simple language. Consider using '%s' rather than '%s'.

• RedHat.Slash warning existence scope: sentence, heading Style guide

  Use either 'or' or 'and' in '%s'

• RedHat.SmartQuotes warning substitution scope: raw

  Do not use smart quotation marks. Use %s rather than %s.

• RedHat.Spacing error existence Style guide

  Keep one space between words in '%s'.

• RedHat.Spelling warning spelling scope: heading, sentence, list, alt, table.header, table.cell, table.caption, figure.caption Style guide

  Verify the word '%s'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

• RedHat.Symbols suggestion existence Style guide

  Do not use the '%s' symbol.

• RedHat.TermsErrors error substitution Style guide

  Use '%s' rather than '%s'.

• RedHat.TermsSuggestions suggestion substitution scope: sentence Style guide

  Depending on the context, consider using '%s' rather than '%s'.

• RedHat.TermsWarnings warning substitution Style guide

  Consider using '%s' rather than '%s' unless updating existing content that uses the term.

• RedHat.UserReplacedValues suggestion existence scope: raw Style guide

  Separate words by underscores in user-replaced values.

• RedHat.Using warning sequence scope: ~heading Style guide

  Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness.