Skip to content

Commit

Permalink
chore: fix typos + address PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
gberenice committed Dec 12, 2024
1 parent 1097d94 commit 009e7c6
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 25 deletions.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We recommend to include:

## Module Repository/Directory Structure

Below is a recommended structure for both Terraform child modules and root modules. Inside each file, you’ll find guidance and best practices that help maintain clarity and consistency across your infrastructure code.
Below is a recommended structure for both TF child modules and root modules. Inside each file, you’ll find guidance and best practices that help maintain clarity and consistency across your infrastructure code.

```sh
.
Expand All @@ -37,19 +37,3 @@ Below is a recommended structure for both Terraform child modules and root modul

- Testing and Examples: Consider adding an examples/ directory with sample configurations and a test/ directory (if using tools like terratest or native Terraform testing) to ensure the module works as intended
- Continuous Improvement: Update documentation and constraints (versions.tf) as Terraform and providers evolve, and as you refine the module’s functionality.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

## Requirements

## Providers

## Modules

## Resources

## Inputs

## Outputs

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
10 changes: 4 additions & 6 deletions root-module/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# root-module

This is a dummy root module.
This is a template root module.

## Recommenations (DO NOT INCLUDE THIS INTO THE REAL README)
## Documentation Recommendations (DO NOT INCLUDE THIS INTO THE REAL README)

- Nodule description: Briefly explain what the root module sets up (e.g., infrastructure for a production environment).
- Usage instructions: Include examples of how to run terraform init, terraform plan, and terraform apply.
- Documentation of variables and outputs: generate variables (from variables.tf) and outputs (from outputs.tf).
- Link to child modules and external resources: If the root module references child modules, mention where they’re located and link to their documentation.
- Module description: Briefly explain what the root module sets up (e.g., infrastructure for RDS Postgres instances).
- Use [terraform-docs](https://github.com/terraform-docs/terraform-docs) to ensure that variables, outputs, child module, and resource documentation is included.
- Maintain current information: Keep the README updated as the infrastructure evolves.

## Structure
Expand Down
4 changes: 2 additions & 2 deletions terraform-random-pet/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# terraform-random-pet

This is a dummy child module.
This is a template child module.

## Recommenations (DO NOT INCLUDE THIS INTO THE REAL README)
## Documentation Recommendations (DO NOT INCLUDE THIS INTO THE REAL README)

### Naming

Expand Down

0 comments on commit 009e7c6

Please sign in to comment.