Skip to content

Commit c840af8

Browse files
committed
Add examples readme
1 parent 9472a21 commit c840af8

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

examples/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Examples
2+
3+
This directory contains examples that are mostly used for documentation, but can also be run/tested manually via the Terraform CLI.
4+
5+
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 are testable even if some parts are not relevant for the documentation.
6+
7+
* `provider/provider.tf` example file for the provider index page
8+
* `data-sources/data_source_name/data-source.tf` example file for the named data source page
9+
* `resources/resource_name/resource.tf` example file for the named data source page
10+
11+
The files in the `defaults/` directory are for Prisma Cloud Compute default configurations.

0 commit comments

Comments
 (0)