From cffb75ee71fcf340ccf7ea770a3470e33a8446be Mon Sep 17 00:00:00 2001 From: Alex ATorres Date: Sat, 30 Mar 2024 07:12:11 +0100 Subject: [PATCH] docs: fix docs --- .markdownlintignore | 5 +++-- README.md | 3 +++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.markdownlintignore b/.markdownlintignore index 9600956..b9f210b 100644 --- a/.markdownlintignore +++ b/.markdownlintignore @@ -1,9 +1,10 @@ .github/PULL_REQUEST_TEMPLATE.md docs/contribution_guidelines.md -docs/contribution_guidelines.md -docs/contribution_guidelines.md .github/ISSUE_TEMPLATE/**.md CONTRIBUTING.md modules/**/README.md examples/**/**/README.md CHANGELOG.md +# Add these lines to ignore specific README.md files for MD025 +infra/terraform/live/_modules/README.md +infra/terraform/live/_providers/README.md diff --git a/README.md b/README.md index 4571b2e..d4a0599 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,9 @@ For more details on how to use Terragrunt and Terraform effectively within this - [Terragrunt Documentation](https://terragrunt.gruntwork.io/docs/) - [Terraform Documentation](https://www.terraform.io/docs/) + +>**NOTE**: Each layer of this architecture has its own README file with detailed explanations and examples. + ## Contributing 🤝 Contributions are welcome! If you have improvements or fixes, please open a pull request. For major changes or new features, please open an issue first to discuss what you would like to change.