-
-
Notifications
You must be signed in to change notification settings - Fork 235
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
Requesting supporting diagrams and documentation #124
Comments
This issue has been automatically marked as stale because it has been open 30 days |
Post for activity, and a gentle nudge to @antonbabenko. |
we are open to PRs if folks are willing to submit them for this type of information |
This issue has been automatically marked as stale because it has been open 30 days |
This issue was automatically closed because of stale in 10 days |
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Is your request related to a problem? Please describe.
This module is pretty awesome and provides valid, powerful and useful features, however it lacks a core part of documentation, which is a network and topology diagram.
Describe the solution you'd like.
For the proposed code options, and examples, it would be great to augment the current terraform documentation with a topology diagram, or permalinks to relevant AWS documentation, which makes it easier for someone to correlate the code to a given network architecture.
Describe alternatives you've considered.
None
Additional context
If there is a given convention and standard for diagrams, I would be happy to document this further myself using diagrams, however I'd need to know what tool to use (if any, unless an exported PNG would be enough). Possibly, options using diagrams as code are good enough, where the diagram generating code lives with the module repo as well.
The text was updated successfully, but these errors were encountered: