Vale and testing
In this recording, we discuss and demo some of our documentation testing tools and frameworks.
Huge thank you to @avgomes_u and @rkratky for putting this all together, and for the live demos.
Let us know your own thoughts on documentation testing in the comments!
00:00 Intro
00:45 Docs Starter Pack
02:28 Makefile
04:20 Command-line demo
05:10 make linkcheck
06:00 make spelling
08:34 Docs checks as GitHub Actions
12:45 Vale
14:45 Vale config generator
15:30 Andreia & vale
16:25 Contractions check
18:20 Vale demo
20:35 VS Code & vale
22:00 Q&A
We record a new Documentation Office Hours every Friday.
Further information
Documentation validation
- Docs Starter Pack (with spellcheck, linkcheck, and inclusive language check): https://github.com/canonical/sphinx-docs-starter-pack
- Vale (highly configurable content linter): https://vale.sh/
- Vale Action for GitHub: https://github.com/errata-ai/vale-action
- and an example implementation: https://github.com/evilnick/canonical-doc-styles
Other stuff
Rick Timmis’s Kubuntu.org work: https://github.com/ricktimmis/kubuntu.org & https://ricktimmis.github.io/kubuntu.org/
- Open Docs Academy repo: https://github.com/canonical/open-documentation-academy (with issue queue: https://github.com/canonical/open-documentation-academy/issues)