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.

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

Project conventions: documentation #58

Open
1 of 2 tasks
ttarczynski opened this issue Jul 5, 2021 · 0 comments
Open
1 of 2 tasks

Project conventions: documentation #58

ttarczynski opened this issue Jul 5, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ttarczynski
Copy link
Contributor

ttarczynski commented Jul 5, 2021

One of our conventions is not yet documented and not enforced with bin/check* scripts.
It is:

The comments that we want to have in all examples:

  • # Summary: – 1-line summary of what this example does
  • # Documentation: – add link to documentation before each block (terraform, provider, variable, resource, etc.)
  • # Explanation: – add only where some extra explanation is needed

TODO:

@ttarczynski ttarczynski added this to the 0.1 Project infrastructure milestone Jul 5, 2021
@ttarczynski ttarczynski self-assigned this Aug 2, 2021
@melihc1 melihc1 added the documentation Improvements or additions to documentation label Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants