README.md

dataops-infra Auto-Docs

These documents are published automatically to infra.dataops.tk using Github Pages and Jekyll.

Dependencies

pip3 install uio logless runnow
brew install terraform-docs

Rebuilding Docs

To rebuild or update all module README docs, run the following command on your dev machine:

cd autodocs
python build.py

To provide additional documentation for a module, you may optionally publish additional documentation into a USAGE.md or NOTES.md file. If one or both of these files exist within a module folder, the content from the additional file(s) will be automatically added into the auto-generated README.md.

Local Testing

To test the docs website locally, follow instructions here: Testing your GitHub pages site locally with Jekyll