Community
A curated list of community-made videos, blog posts, and other resources about Vale and its related software.
| Connect | |
|---|---|
| GitHub Discussions | Ask questions, share configurations, and engage in general Vale-related discussion. |
| GitHub Issues | Report a bug, submit a feature request, or start a PR. |
Slack (#testthedocs) | Discuss Vale with the Write the Docs community (join here, if you're not already a member). |
Have your own video, post, or resource? Feel free to submit it here.
Articles
- How To Automate Documentation Workflow For Developers (Portia Burton)
- First steps with the Vale prose linter (Fabrizio Ferri Benedetti)
- Writing Articles with Vale (Thedro Neely)
- Linting your content using Vale (Shweta Shetye)
- Docs as Code at Linode (Nathan Melehan, Linode)
- Testing docs with Vale - Part 1: Installing the Vale CLI (Deanna Thompson)
- Prose linting with Vale and Emacs (Duncan Mac-Vicar P.)
- Linting the Buildkite Docs (Sam Wright, Buildkite)
- Sofie's Docs Diary Vol. 16: Writing in style (Sofie Toft Kristensen, Umbraco)
- Linting my prose with Vale (Alex Wilson)
- Automated Enforcement of our Style Guide (Joe Shindelar, Drupalize.Me)
- Testing your Documentation (Write the Docs)
- Vale for Spelling, Grammar, Style and Readability Linting (Chris Ward)
Videos
- Documentation as code (Part 3): A Linting How To - The Vale Linter in Action (Tag1)
- Docs-as-Code Workflow for your (API) Developer Portal (Pronovix)
- Day 1 Lightning Talk #3 - Write the Docs Prague 2019 (Write the Docs)
- Reducing Negative and Biased Language in Documentation (All Things Open)
Examples
Check out example open-source Vale configurations from companies and organizations around the world.
Homebrew
An implemetation of a custom, in-house style for the Homebrew docs.
Chef Software, Inc.
A custom style, vocab, and output format for the Chef reference documentation.
GitHub
A custom style built on top of the Microsoft Writing Style Guide.
Netlify
A custom style and vocab for Netlify CMS website.
Linode
A custom configuration for Hugo-powered Markdown docs.
GitLab
An extensive Vale configuration for various GitLab projects.
Backstage
A basic Vale configuration for Spotify's Backstage project.
CockroachDB
A custom style for the CockroachDB user documentation.
Eclipse Che
An advanced Vale configuration for the Eclipse Che Documentation.
Write the Docs
A custom style for the Write the Docs website.
Mautic
A configuration for the Mautic project based on the Google Developer Documentation Style Guide.
webpack
A proselint-based Vale configuration for the webpack website.
Algolia
A fork of the Vale GitHub action maintained by Algolia.
Datadog, Inc.
A custom style for the Datadog documentation.
Rackspace
A custom style for the Rackspace Expert Insights Technical Blog.
Vaadin
A custom style and configuration for the Vaadin docs.
Oxygen XML
A Vale Validation add-on for the Oxygen XML editor.
Beyond Code
Syntax-aware proofreading for your Laravel application.