resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

website: Clarify submodule examples location 

When writing an example for a submodule, the example should be placed in
`examples/{example name}` instead of
`modules/{module name}/examples/{example name}`.
This commit is contained in:
Justin Campbell 2018-01-17 14:56:05 -05:00
parent e9476c6765
commit 0f00291dfe
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/docs/modules/create.html.markdown
View File

@ -161,8 +161,9 @@ standard structure.
own IAM policy choices.
* **Examples**. Examples of using the module should exist under the
`examples/` subdirectory. Each example may have a README to explain the
goal and usage of the example.
`examples/` subdirectory at the root of the repository. Each example may have
a README to explain the goal and usage of the example. Examples for
submodules should also be placed in the root `examples/` directory.
A minimal recommended module following the standard structure is shown below.
While the root module is the only required element, we recommend the structure