From 699559b0051303bd0aeeaad06ceb53b9c0f8e4d5 Mon Sep 17 00:00:00 2001 From: badra001 Date: Wed, 17 Nov 2021 13:11:02 -0500 Subject: [PATCH] add docs for examples --- examples/.terraform-docs.yml | 44 ++++++++++++++++++++++++++++++++++++ examples/README.md | 12 ++++++++++ 2 files changed, 56 insertions(+) create mode 100644 examples/.terraform-docs.yml create mode 100644 examples/README.md diff --git a/examples/.terraform-docs.yml b/examples/.terraform-docs.yml new file mode 100644 index 0000000..8391b9d --- /dev/null +++ b/examples/.terraform-docs.yml @@ -0,0 +1,44 @@ +formatter: markdown table + +header-from: main.tf +footer-from: "" + +sections: +## hide: [] + show: + - data-sources + - header + - footer + - inputs + - modules + - outputs + - providers + - requirements + - resources + +output: + file: README.md + mode: inject + template: |- + + {{ .Content }} + + +## output-values: +## enabled: false +## from: "" +## +## sort: +## enabled: true +## by: name +## +## settings: +## anchor: true +## color: true +## default: true +## description: false +## escape: true +## indent: 2 +## required: true +## sensitive: true +## type: true diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..d14d1fa --- /dev/null +++ b/examples/README.md @@ -0,0 +1,12 @@ +# Examples + +Here we have some examples for use of this module and supporting submodules. + +## policy +## s3 standard +## s3 title26 +## kms_key + + +{{ .Content }} +