• Home

Vale for writers at Red Hat

  • Vale at Red Hat user guide
    • Introduction
    • Installing Vale
    • Installing the RedHat style
    • Analyzing your content
      • Using the Vale-at-Red-Hat web app
      • Analyzing with the Vale CLI
      • Understanding Vale alerts
      • Collating Vale output
      • Vale in the IDE
    • RedHat style
    • AsciiDoc style
    • OpenShift AsciiDoc style
    • Glossary
    • Vale reports
    • Onboarding strategy
    • Adding Vale to a project
    • Create a vocabulary
    • Integrating Vale into your GitHub workflow
    • GitLab Code Quality reports
    • Continuous integration
  • Vale at Red Hat contributor guide
    • Contributing
    • Repository
    • Extending Spelling
    • Extending rules
  • Vale rules reference guide
    • Abbreviations
    • Case sensitive terms
    • Conjunctions
    • Conscious language
    • Contractions
    • Definitions
    • Do not use terms
    • Ellipses
    • Em dashes
    • Heading punctuation
    • Headings
    • Hyphens
    • Merge conflict markers
    • Oxford comma
    • Pascal and camel case terms
    • Passive voice
    • Product-centric writing
    • Readability grade
    • Release notes
    • Repeated words
    • Self-referential text
    • Sentence length
    • Simple words
    • Slash
    • Smart quotes
    • Spacing
    • Spelling
    • Symbols
    • Error terms
    • Suggestion terms
    • Warning terms
    • User-replaced values
    • Using
Vale for writers at Red Hat main
  • Vale for writers at Red Hat
    • main
  • Vale for writers at Red Hat
  • Links
Edit this page

Links

Always include link text for URLs. The link text must be descriptive.

Additional resources

  • Red Hat supplementary style guide for product documentation - Links and hypertext

Site map | Guidelines for Red Hat Documentation | Developer Certificate of Origin | MIT License