Need more than a rule playground?

Explore Vale CMS
Package Explorer

OpenShiftAsciiDoc

A Vale-compatible implementation of select AsciiDoc guidance from the OpenShift docs contributor guidelines.

Source style

Getting started

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

Packages = OpenShiftAsciiDoc

[*.md]
BasedOnStyles = Vale, OpenShiftAsciiDoc

Rules 16

12 error1 warning3 suggestion
  • OpenShiftAsciiDoc.AdditionalResourcesHeadingHasRoleID suggestion existence scope: raw Style guide

    Additional resources heading is missing the '_additional-resources' role attribute declaration

  • OpenShiftAsciiDoc.CheckDollarSymbolInTerminalBlock suggestion existence scope: raw Style guide

    Terminal code block missing a command prompt at the beginning of the line. For example output, prepend the code block with '.Example output'.

  • OpenShiftAsciiDoc.HardWrappedLines warning script scope: raw

    Avoid hard-wrapped lines.

  • OpenShiftAsciiDoc.IdHasContextVariable error existence scope: raw Style guide

    ID is missing the '_{context}' variable at the end of the ID.

  • OpenShiftAsciiDoc.ModuleContainsContentType error occurrence scope: raw Style guide

    Module is missing the '_mod-docs-content-type' variable.

  • OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment suggestion occurrence scope: raw Style guide

    The comment at the beginning of the module that lists the parent assembly is missing.

  • OpenShiftAsciiDoc.NoLineRanges error existence scope: raw Style guide

    Do not use line ranges for included files.

  • OpenShiftAsciiDoc.NoNestingInModules error existence scope: raw Style guide

    You can only nest snippets or GitHub raw user content in modules.

  • OpenShiftAsciiDoc.NoOptionalTitles error existence scope: raw Style guide

    Do not begin a module or assembly title with 'Optional:'.

  • OpenShiftAsciiDoc.NoTocInModules error existence scope: raw Style guide

    Do not include TOCs in modules, only assemblies.

  • OpenShiftAsciiDoc.NoXrefInModules error existence scope: raw Style guide

    Do not include xrefs in modules, only assemblies (exception: release notes modules).

  • OpenShiftAsciiDoc.SuggestAttribute error substitution Style guide

    Use the AsciiDoc attribute '%s' rather than the plain text product term '%s', unless your use case is an exception.

  • OpenShiftAsciiDoc.TrailingBackslash error existence scope: raw

    Code example ends with an unescaped trailing backslash.

  • OpenShiftAsciiDoc.XrefContainsAnchorID error existence scope: raw Style guide

    The xref is missing an anchor ID.

  • OpenShiftAsciiDoc.XrefContainsHTML error existence scope: raw Style guide

    Use .adoc instead of .html in xrefs

  • OpenShiftAsciiDoc.XrefMustNotHaveNakedLabel error existence scope: raw Style guide

    The xref is missing link text.