Skip to content

Commit 8fd3062

Browse files
committed
add multiple terraform-docs configs to generate a seperated markdown document for input variables
1 parent da5c54e commit 8fd3062

5 files changed

Lines changed: 158 additions & 4 deletions

File tree

.terraform-docs.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

.terraform-docs/README.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
formatter: "markdown table" # this is required
2+
3+
sections:
4+
hide: ["inputs"]
5+
output:
6+
file: "README.md"
7+
mode: inject

.terraform-docs/variables.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
formatter: "markdown table" # this is required
2+
3+
sections:
4+
show: ["inputs"]
5+
output:
6+
file: "variables.md"
7+
mode: inject

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,8 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
202202

203203
## Module Spec
204204

205+
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)
206+
205207
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!**
206208

207209
<!-- BEGIN_TF_DOCS -->

0 commit comments

Comments
 (0)