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

Requesting supporting diagrams and documentation #124

Closed
stv-io opened this issue Jan 2, 2024 · 6 comments
Closed

Requesting supporting diagrams and documentation #124

stv-io opened this issue Jan 2, 2024 · 6 comments

Comments

@stv-io
Copy link

stv-io commented Jan 2, 2024

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.

Copy link

github-actions bot commented Feb 2, 2024

This issue has been automatically marked as stale because it has been open 30 days
with no activity. Remove stale label or comment or this issue will be closed in 10 days

@github-actions github-actions bot added the stale label Feb 2, 2024
@stv-io
Copy link
Author

stv-io commented Feb 2, 2024

Post for activity, and a gentle nudge to @antonbabenko.

@bryantbiggs
Copy link
Member

we are open to PRs if folks are willing to submit them for this type of information

@github-actions github-actions bot removed the stale label Feb 3, 2024
Copy link

github-actions bot commented Mar 4, 2024

This issue has been automatically marked as stale because it has been open 30 days
with no activity. Remove stale label or comment or this issue will be closed in 10 days

@github-actions github-actions bot added the stale label Mar 4, 2024
Copy link

This issue was automatically closed because of stale in 10 days

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 15, 2024
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants