Auto generate documentation from Terraform modules

• blog-devto

  15 26 9.4 PowerShell

  Dev.to blog posts

Take a look here to see what the README.md document looks like: example_README.md

• Azure-Terraform-Deployments

  5 35 8.2 HCL

  Repo used to deploy Azure Resources using Terraform and GitHub Actions

In my GitHub repository called: Azure-Terraform-Deployments, notice that I have structured my terraform module code with folders using a numbering system e.g: '01_Foundation', '02_Storage', etc.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• terraform-docs

  32 4,007 7.7 Go

  Generate documentation from Terraform modules in various output formats

  

Today we are going to look at a cool tool that can be used to "automagically" generate your Terraform module documentation called terraform-docs.

Suggest a related project