Elastic

Getting started

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

Packages = Elastic

[*.md]
BasedOnStyles = Vale, Elastic

• Elastic.Accessibility warning existence Style guide

  Don't use language (such as '%s') that defines people by their disability.

• Elastic.Articles warning substitution Style guide

  Use '%s' instead of '%s'. The article depends on pronunciation, not spelling.

• Elastic.BritishSpellings warning substitution Style guide

  Use American English spelling '%s' instead of British English '%s'.

• Elastic.Clone suggestion existence Style guide

  Use `%s` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.

• Elastic.ConflictMarkers error existence scope: raw

  Do not commit Git merge conflict markers in source code.

• Elastic.DeviceAgnosticism suggestion substitution Style guide

  Use device-agnostic language when possible. Use '%s' instead of '%s'.

• Elastic.Dimensions suggestion existence Style guide

  Avoid using dimensions in the format 'M X N'. Use 'MxN' instead.

• Elastic.DirectionalLanguage warning substitution Style guide

  Don't use directional language. Use '%s' instead of '%s'.

• Elastic.DontUse warning existence Style guide

  Don't use '%s'.

• Elastic.Ellipses suggestion existence Style guide

  In general, don't use an ellipsis.

• Elastic.EndPuntuaction warning existence scope: heading Style guide

  Don't end headings with punctuation.

• Elastic.Exclamation suggestion existence Style guide

  Use exclamation points sparingly. Consider removing the exclamation point.

• Elastic.FirstPerson suggestion existence Style guide

  Use caution when using first-person pronouns such as '%s.'

• Elastic.Gender warning existence Style guide

  Don't use '%s'.

• Elastic.GenderBias suggestion substitution Style guide

  Consider using '%s' instead of '%s'.

• Elastic.HeadingColons suggestion existence scope: heading Style guide

  Capitalize '%s'.

• Elastic.KibanaChromeTerms suggestion substitution Style guide

  Consider using '%s' instead of '%s' when referring to parts of the Kibana chrome.

• Elastic.Latinisms warning substitution Style guide

  Latin terms and abbreviations are a common source of confusion. Use '%s' instead of '%s'.

• Elastic.MappedPages warning existence scope: raw

  mapped_pages should only be added or updated in rare scenarios. Talk with your local technical writer before pushing changes to this key.

• Elastic.MeaningfulCTAs warning substitution Style guide

  Use meaningful link text. Use '%s' instead of '%s'.

• Elastic.MenuArrows warning existence Style guide

  Use '→' to separate menu items, not '>' or '=>'. Example: Select Manage index → Add lifecycle policy.

• Elastic.MenuArrowsBold warning existence scope: raw Style guide

  Use '→' to separate menu items, not '>' or '=>'. Example: Select Manage index → Add lifecycle policy.

• Elastic.Negations suggestion existence Style guide

  Consider rephrasing to avoid negative constructions like '%s'. Try stating what something IS rather than what it is NOT.

• Elastic.OxfordComma suggestion existence scope: sentence Style guide

  Use the Oxford comma in '%s'.

• Elastic.PluralAbbreviations warning sequence Style guide

  Don't use apostrophes when making abbreviations plural. Use '%s' instead of '%s'.

• Elastic.QuotesPunctuation warning existence Style guide

  Place punctuation inside closing quotation marks.

• Elastic.Repetition suggestion repetition Style guide

  "%s" is repeated.

• Elastic.Semicolons suggestion existence scope: sentence Style guide

  Use semicolons judiciously.

• Elastic.Spelling warning spelling

  '%s' is a possible misspelling.

• Elastic.Versions suggestion substitution

  Use '%s' instead of '%s' when referring to versions.

• Elastic.WordChoice suggestion substitution Style guide

  Consider using '%s' instead of '%s', unless the term is in the UI.

• Elastic.Wordiness suggestion substitution scope: ~text.frontmatter.navigation_title Style guide

  Consider using '%s' instead of '%s'.