Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
3 tasks
Tracked by #58
eminalemdar opened this issue Sep 1, 2022 · 2 comments
Open
3 tasks
Tracked by #58

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

eminalemdar opened this issue Sep 1, 2022 · 2 comments
Labels
CI CI related topics - actions, tooling, scripts, etc. documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@eminalemdar
Copy link

eminalemdar commented Sep 1, 2022 •
edited
Loading

  • Create check_docs.sh script
  • Automatically check documentation conventions in the script conventions
  • Add/Run the script on CI at every commit
@eminalemdar eminalemdar mentioned this issue Sep 1, 2022
Open
2 tasks
@ttarczynski ttarczynski changed the title add a bin/check_docs.sh script to enforce it add a bin/check_docs.sh script to enforce documentation conventions Sep 1, 2022
@eminalemdar eminalemdar added documentation Improvements or additions to documentation CI CI related topics - actions, tooling, scripts, etc. good first issue Good for newcomers labels Sep 1, 2022
@CypherpunkSamurai
Copy link

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI CI related topics - actions, tooling, scripts, etc. documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@CypherpunkSamurai @eminalemdar