Merge pull request #17126 from hashicorp/module-examples-clarification

website: Clarify submodule examples location
This commit is contained in:
James Bardin 2018-01-25 14:04:08 -05:00 committed by GitHub
commit 142dd6632b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions

View File

@ -161,8 +161,9 @@ standard structure.
own IAM policy choices. own IAM policy choices.
* **Examples**. Examples of using the module should exist under the * **Examples**. Examples of using the module should exist under the
`examples/` subdirectory. Each example may have a README to explain the `examples/` subdirectory at the root of the repository. Each example may have
goal and usage of the example. 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. A minimal recommended module following the standard structure is shown below.
While the root module is the only required element, we recommend the structure While the root module is the only required element, we recommend the structure