README.md

build-docs

An Ansible role to assemble documentation for RPK from common documentation fragments.

• Builds the component documentation tables, which gets inserted into the cloud provider QUICKSTART documentation. This uses the rpk_components data for the rpk_supported_profiles variable in defaults/main.yaml.

• Builds the main cloud provider QUICKSTART documentation found in /docs/providers from the templates and common sections in templates/sections/main and templates/sections/common respectively.

• Builds table of contents for the cloud provider QUICKSTART documentation based off of the headings found from the assembled main documentation in templates/built. The table of contents template can be found in templates/toc.

• Assembles the final version of the documentation with title, table of contents, and content from the provider templates in templates with generated content from templates/built.

Author

Andrew J. Huffman