Feature: Create Terraform usage documentation with terraform-docs - Githubissues

blinqas / station

Use Station to create secure and automated environments for your workloads in Azure

MIT License

7 stars 1 forks source link

Feature: Create Terraform usage documentation with terraform-docs #159

Closed kimfy closed 2 weeks ago

kimfy commented 1 month ago

Feature Description

Include output of running terraform-docs at the bottom of the main README file in its own section
Automatically hide
Automate with GitHub Action

The command I used in the branch docs/readme-20:

terraform-docs markdown table --output-file README.md --output-mode inject .

Problem and Motivation

Looking up input usage in the README is useful at times

Possible Implementation

See the README in branch docs/readme-20