Initial commit
This commit is contained in:
9
examples/README.md
Normal file
9
examples/README.md
Normal file
@@ -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
|
||||
3
examples/data-sources/scaffolding_example/data-source.tf
Normal file
3
examples/data-sources/scaffolding_example/data-source.tf
Normal file
@@ -0,0 +1,3 @@
|
||||
data "scaffolding_example" "example" {
|
||||
configurable_attribute = "some-value"
|
||||
}
|
||||
3
examples/provider/provider.tf
Normal file
3
examples/provider/provider.tf
Normal file
@@ -0,0 +1,3 @@
|
||||
provider "scaffolding" {
|
||||
# example configuration here
|
||||
}
|
||||
3
examples/resources/scaffolding_example/resource.tf
Normal file
3
examples/resources/scaffolding_example/resource.tf
Normal file
@@ -0,0 +1,3 @@
|
||||
resource "scaffolding_example" "example" {
|
||||
configurable_attribute = "some-value"
|
||||
}
|
||||
Reference in New Issue
Block a user