osc-doc-framework is a framework for generating OUTSCALE documentations, and most primarily the OUTSCALE Public Documentation. It is based on the Antora documentation site generator, with additional custom extensions designed to facilitate the work of technical writers.
In addition to the default Antora features, this framework enables the following:
-
API doc generation via Widdershins
-
Prose linting and Style Guide validation via Vale
-
Search engine via Antora Lunr Extension
-
Release note pages with clickable filters
-
404 page with randomized images
-
RSS feed generation
-
Automatic tooltips
-
…and more
There are multiple ways to install osc-doc-framework for your Antora documentation project. If you are an OUTSCALE technical writer, see the README of the internal userguide repository for team-specific instructions.
Otherwise, see antora-repo-example for a working example.
You can configure your Git to use the pre-commit hook in the git-hooks folder. This pre-commit hook will run Vale on your the files of your Antora project in order to lint them with the Style Guide rules located in the Vale/styles directory.