Description

When writing docs, contributors might not have all the tooling installed, and often do content modifications without checking how it renders or if the site even builds.

In other side, the reviewers, mainly docs' team members, once they made all the adjustments and test it locally, have from time-to-time surprises during publishing, as the repository pipelines might not be updated or well configured.

One potential solution to fix these two issues, is to switch to Docs as Code process, and use tools like Dagger.io to test the end-to-end process.

The advantages will be that contributors don't have to learn XYZ framework and have it installed on their local machine, just for the sake of docs. And the reviewers will be able to trust their local reviews and tests to be fully adapted to the publishing pipelines.

Goals

Initial goal: Document the steps for setting up a "dag" for a docs' repo and provide instructions on how to run it. Extra goal: Use a containerized approach to avoid installing "yet another tool" Week goal: Have a working demo by end of hack week.

Resources

Main site: dagger.io OSS docs project "test subject": github.com/rancher/turtles-docs Docs stack: AsciiDoc + Antora Language(s) used: Python (and/or Go)