add a `bin/check_docs.sh` script to enforce documentation conventions

ContainerSolutions / terraform-examples

Simple and idiomatic examples of various Terraform functions and features.

https://containersolutions.github.io/terraform-examples/

160 stars 52 forks source link

add a `bin/check_docs.sh` script to enforce documentation conventions #183

Open eminalemdar opened 1 year ago

eminalemdar commented 1 year ago

[ ] Create check_docs.sh script
[ ] Automatically check documentation conventions in the script conventions
[ ] Add/Run the script on CI at every commit

CypherpunkSamurai commented 1 year ago

Hello Sir, I'm interested in contributing to the issue.

I have 1 question regarding this issue, would you please explain what the check_docs.sh script would perform?

eminalemdar commented 1 year ago

Hello Sir, I'm interested in contributing to the issue.

I have 1 question regarding this issue, would you please explain what the check_docs.sh script would perform?

Hello there! Thank you for considering contribution to the project! You can first check out our Contribution Document

The check_docs.sh script should check the documentation conventions referred here. Specifically this part: Add inline documentation for each Terraform code block.