config: adds files for document generation

Author: nimisha-gj

.terraform-docs-example.yaml

@@ -0,0 +1,37 @@
+  formatter: "markdown table"
+
+  header-from: ../../example.header.md
+  footer-from: ""
+
+  recursive:
+    enabled: true
+    path: examples
+    include-main: false
+
+  output:
+    file: "README.md"
+    mode: replace
+    template: |-
+      <!-- BEGIN_TF_DOCS -->
+      {{ .Content }}
+      <!-- END_TF_DOCS -->
+      {{- printf "\n" -}}
+
+  sort:
+    enabled: true
+    by: name
+
+  settings:
+    anchor: true
+    color: true
+    default: true
+    description: false
+    escape: true
+    hide-empty: false
+    html: true
+    indent: 2
+    lockfile: true
+    read-comments: true
+    required: true
+    sensitive: true
+    type: true

example.header.md

@@ -0,0 +1,11 @@
+    ## Usage
+
+  To run this example you need to execute:
+
+  ```bash
+  $ terraform init
+  $ terraform plan
+  $ terraform apply
+  ```
+
+  Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.