docs: Improve provider documentation

datadrivers · Jun 1, 2022 · c773521 · c773521
1 parent 6a4ae6e
commit c773521
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 5 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,14 +1,13 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "convention Provider"
+page_title: "Provider: Convention"
 subcategory: ""
 description: |-
-  
+  The Convention provider allows the generation of names following the configured convention
 ---
 
-# convention Provider
-
+# Convention Provider
 
+The Convention provider allows the generation of names following the configured convention
 
 ## Example Usage
 
@@ -51,3 +50,7 @@ Required:
 - `generated` (Boolean) Activates the generation of a random string
 - `max_length` (Number) Set the size limit of the value. Required if value is generated
 - `name` (String) Name of the variable
+
+## Author
+
+[Datadrivers GmbH](https://www.datadrivers.de)
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,9 @@
+# Examples
+
+This directory contains examples that are mostly used for documentation, but can also be run/tested manually via the Terraform CLI.
+
+The document generation tool looks for files in the following locations by default. All other *.tf files besides the ones mentioned below are ignored by the documentation tool. This is useful for creating examples that can run and/or ar testable even if some parts are not relevant for the documentation.
+
+* **provider/provider.tf** example file for the provider index page
+* **data-sources/`full data source name`/data-source.tf** example file for the named data source page
+* **resources/`full resource name`/resource.tf** example file for the named data source page
diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -0,0 +1,20 @@
+---
+page_title: "Provider: Convention"
+subcategory: ""
+description: |-
+  The Convention provider allows the generation of names following the configured convention
+---
+
+# Convention Provider
+
+The Convention provider allows the generation of names following the configured convention
+
+## Example Usage
+
+{{tffile "examples/provider/provider.tf"}}
+
+{{ .SchemaMarkdown | trimspace }}
+
+## Author
+
+[Datadrivers GmbH](https://www.datadrivers.de)