Create a readme for the terraform component
We need to follow the guidelines provided in the Gitlab docs on components linked here - to write a clear readme.md for the terraform-component.
Each component project should have clear and comprehensive documentation. To write a good README.md file:
- Start with a summary of the capabilities that the components provide.
- If the project contains multiple components, use a table of contents to help users quickly jump to a specific component’s details.
- Add a ## Components section with sub-sections like ### Component A for each component.
- In each component section:
- Describe what the component does.
- Add at least one YAML example showing how to use it.
- Use spec:inputs:description to document any variables or secrets the component uses.
- Do not duplicate input documentation in the README. Inputs appear automatically on the component page. Instead, link to the published component.
- Add a ## Contribute section if contributions are welcome.
If a component needs more instructions, add additional documentation in a Markdown file in the component directory and link to it from the main README.md file. For example:
README.md # with links to the specific docs.md
templates/
├── component-1/
│ ├── template.yml
│ └── docs.md
└── component-2/
├── template.yml
└── docs.md
For an example, see the AWS components README.
Edited by Eesaan Atluri