Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README.md
Having a Readme.md file is mandatory for every module. Please ensure that you include the following information inside the readme file:
Module Name and Description:
Provide a clear and concise name for the module.
Include a brief description or summary of the module's purpose and functionality.
How to Use this Building Block inside meshStack:
Explain how to effectively utilize this module within meshStack.
Specify any required variables and inputs, along with their descriptions and usage instructions.
Creating a backend.tf File:
Reference the related wiki page that explains how to create a backend.tf file.
Include a link or provide clear instructions. For example: "You can find an example of how to create a backend.tf file on this Wiki Page."
Include any other pertinent details about the module.
Consider adding information such as pricing details for the workload, if applicable, to help users better understand the module's implications.
Pull Request Description
Please provide a brief summary of the changes made in this pull request. And make sure to follow the regular naming conventions.
Related Issues
Checklist
Thank you for your attention to these documentation requirements.