1 changed file
README.md | ||
Add comment 66
Add comment 67 1. Module Demo: This sample simply provisions the module to demonstrate one or more valid configurations for the module (e.g. resource SKU, various feature flags, different combinations of input variable parameters)
Add comment 68 2. Architectural Scenario: Samples of this type demonstrate the use of several modules from the library working together to implement a common architectural pattern or blueprint (e.g. )
Add comment 69 Plus
Add comment 70 Plus ## Module documentation
Add comment 71 Plus
Add comment 72 Plus ### Documentation structure
Add comment 73 Plus Our documentation for each module will be structured in the following manner:
Add comment 74 Plus
Add comment 75 Plus * **Description**: A short description of the module.
Add comment 76 Plus * **Usage**: A code sample that shows the usage of the module.
Add comment 77 Plus * **Scenarios**: Description of the primary and other common scenarios to use the module.
Add comment 78 Plus * **Samples**: A list of samples that demonstrate the usage of this module.
Add comment 79 Plus * **Requirements**: The versions of terraform and providers required to use this module.
Add comment 80 Plus * **Providers**: The versions of the providers required to use this module.
Add comment 81 Plus * **Modules**: The modules referenced / provisioned by this module.
Add comment 82 Plus * **Resources**: The resources provisioned by this module.
Add comment 83 Plus * **Inputs**: The inputs this module takes along with their description, type, default and whether they are required.
Add comment 84 Plus * **Outputs**: The outputs this module gives and their description.
Add comment 69 85