From 0f00291dfe927fa59a6bfb5cf778dbc93146e0d3 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Wed, 17 Jan 2018 14:56:05 -0500 Subject: [PATCH] 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}`. --- website/docs/modules/create.html.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/docs/modules/create.html.markdown b/website/docs/modules/create.html.markdown index 122fb15e0..6bd2fdd94 100644 --- a/website/docs/modules/create.html.markdown +++ b/website/docs/modules/create.html.markdown @@ -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