Generate documentation from Terraform modules in various output formats (by terraform-docs)

Terraform-docs Alternatives

Similar projects and alternatives to terraform-docs

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a better terraform-docs alternative or higher similarity.

terraform-docs reviews and mentions

Posts with mentions or reviews of terraform-docs. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2023-02-18.
  • How to understand existing code?
    2 projects | reddit.com/r/Terraform | 18 Feb 2023
    I'm going to have to figure out how to run terraform-docs.io against each module. I have zero terraform experience.
    2 projects | reddit.com/r/Terraform | 18 Feb 2023
    One thing you might try is running https://terraform-docs.io/ against each module. You can generate markdown that more or less tells you the inputs and outputs for each module so you don't have to go hunt them down if the module authors have scattered their declarations around the different .tf files. Also if you're lucky enough that they actually put the description fields in to the declarations, it will put that in the markdown also. Just knowing the module interfaces goes a long way in understanding what the modules do or can't do, what stuff is hard coded and what stuff you need to hunt for, e.g. are there a bunch of data terraform_remote_state resources pulling inputs in to the module instead of using variable declarations, etc.
  • 5 tools to supercharge your Terraform Development
    3 projects | dev.to | 12 Jan 2023
    Terraform-docs: This tool generates documentation for your Terraform modules in various formats, such as Markdown, HTML, and JSON. Terraform-docs parses your Terraform code and extracts documentation from comments, variable and output descriptions, and input/output examples. The tool then generates a table of contents with links to the relevant documentation for each module, which makes it easy to understand the purpose and usage of each module.
  • How to Write an Awesome Readme
    2 projects | dev.to | 28 Dec 2022
    Terraform docs
  • Terraform documentation of modules with nested inputs with optuonals?
    2 projects | reddit.com/r/Terraform | 11 Dec 2022
    I have been using https://terraform-docs.io to generate documentation of my terraform modules. However creating nested objects with optionals makes the documentation rather ugly and hard to read. See gh issue which also describes this type of issue: https://github.com/terraform-docs/terraform-docs/issues/656
  • Automating release docs for ansible roles
    3 projects | reddit.com/r/ansible | 28 Oct 2022
    I am looking for a way to automate doc creation and updates for ansible roles. I recently discovered terraform-docs and I am curious if there is something similar for ansible.
  • List of most useful Terraform open-source tools
    10 projects | news.ycombinator.com | 28 Aug 2022
    terraform-docs: https://github.com/terraform-docs/terraform-docs

    Do you have other Terraform-related open-source tools that you recommend? Please go ahead and add in the comments!

    14 projects | reddit.com/r/Terraform | 28 Aug 2022
    Documentation:terraform-docs: https://github.com/terraform-docs/terraform-docs
  • Our company is choosing Terraform for Azure IAC.
    3 projects | reddit.com/r/Terraform | 24 Aug 2022
  • Treating your terraform code "as an app". Favouring inputs over code changes. I wish I saw more like this in places I worked at.
    2 projects | reddit.com/r/Terraform | 19 Aug 2022
    This was a decent read. I definitely found myself agreeing with many of the points here. I do prefer terragrunt over the use of tfvar files though and I didn't see terraform-docs mentioned which is an excellent tool for building standardized module documentation
  • A note from our sponsor - ONLYOFFICE
    www.onlyoffice.com | 2 Jun 2023
    Powerful document editing and collaboration in your app or environment. Ultimate security, API and 30+ ready connectors, SaaS or on-premises Learn more →


Basic terraform-docs repo stats
about 1 month ago
ONLYOFFICE Docs — document collaboration in your environment
Powerful document editing and collaboration in your app or environment. Ultimate security, API and 30+ ready connectors, SaaS or on-premises