Skip to content

Commit

Permalink
Merge pull request #441 from lonegunmanb/enhance-document
Browse files Browse the repository at this point in the history
Add multiple terraform-docs configs to generate a seperated markdown document for input variables
  • Loading branch information
jiaweitao001 authored Sep 18, 2023
2 parents 4408dab + e9b96d2 commit 3c005f4
Show file tree
Hide file tree
Showing 5 changed files with 159 additions and 4 deletions.
4 changes: 0 additions & 4 deletions .terraform-docs.yml

This file was deleted.

7 changes: 7 additions & 0 deletions .terraform-docs/README.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
formatter: "markdown table" # this is required

sections:
hide: ["inputs"]
output:
file: "README.md"
mode: inject
7 changes: 7 additions & 0 deletions .terraform-docs/variables.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
formatter: "markdown table" # this is required

sections:
show: ["inputs"]
output:
file: "variables.md"
mode: inject
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,8 @@ contact [[email protected]](mailto:[email protected]) with any additio

## Module Spec

Input variable spec are too big for the registry to render so we have a seperated document for these variables, check it out [here](./variables.md)

The following sections are generated by [terraform-docs](https://github.com/terraform-docs/terraform-docs) and [markdown-table-formatter](https://github.com/nvuillam/markdown-table-formatter), please **DO NOT MODIFY THEM MANUALLY!**

<!-- BEGIN_TF_DOCS -->
Expand Down
Loading

0 comments on commit 3c005f4

Please sign in to comment.