diff options
| author | Julien Dessaux | 2023-06-19 00:05:58 +0200 |
|---|---|---|
| committer | Julien Dessaux | 2023-06-19 00:05:58 +0200 |
| commit | 18ae275c5b071ed9e4cd1d407c08a7b8c1f526e3 (patch) | |
| tree | b056a349cfafd8c14dd5dbc7f0915d1a8a8a8283 /examples/README.md | |
| parent | Imported and modified evcli's api client code (diff) | |
| download | terraform-provider-eventline-18ae275c5b071ed9e4cd1d407c08a7b8c1f526e3.tar.gz terraform-provider-eventline-18ae275c5b071ed9e4cd1d407c08a7b8c1f526e3.tar.bz2 terraform-provider-eventline-18ae275c5b071ed9e4cd1d407c08a7b8c1f526e3.zip | |
Prepared everything for the first release
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..026c42c --- /dev/null +++ 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 |