From 18ae275c5b071ed9e4cd1d407c08a7b8c1f526e3 Mon Sep 17 00:00:00 2001
From: Julien Dessaux
Date: Mon, 19 Jun 2023 00:05:58 +0200
Subject: Prepared everything for the first release

---
 examples/README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 examples/README.md

(limited to 'examples/README.md')

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
-- 
cgit v1.2.3