Added terraform-docs for better documentation #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
baixiac
approved these changes
Dec 6, 2024
keyvaann
commented
Dec 6, 2024
|
|
||
| ## Contributing | ||
|
|
||
| Make sure to install [terraform-docs](https://github.com/terraform-docs/terraform-docs) and run `make prepare` before making a commit to make sure the documentation is up to date and the code is valid. |
There was a problem hiding this comment.
@baixiac There is a brief description about it here
There was a problem hiding this comment.
Oh sorry, it slipped through somehow. Sounds like it would be a good use case for the git pre-commit hook?
There was a problem hiding this comment.
Yes it would be good for that but it needs extra configuration and documentation that I think we can do at a later time.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added
terraform-docsand some other small improvements.