search

iits-consulting / terraform-opentelekomcloud-project-factory

This repository helps to create an OTC-based cloud-native infrastructure landscape with Kubernetes, load balancers, VPCs, etc. With these modules, we provide you a rocket start while you can still deep-dive into detailed configuration later.
GNU General Public License v3.0
83 stars 20 forks source link

Generate parts of the documentation with terraform-docs #87

Closed mattiascockburn closed 1 year ago

mattiascockburn commented 1 year ago

Here we try to introduce automatic updates to parts of the documentation of the different modules. We leave most of the README files as-is and use terraform-docs to inject information into them.

This PR also includes a GH action the automates this process in PRs

mattiascockburn commented 1 year ago

The current implementation of terraform-docs mangles the README.md in the root of the project. We would need to completely restructure all the documentation in order to 'maybe' mitigate this issue. If you don't mind the extraneous/useless sections at the bottom of the root README.md for now you may go ahead and merge this.