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

Add detailed docs into module README.md files #67

Open
4 tasks
mogul opened this issue Mar 10, 2025 · 0 comments
Open
4 tasks

Add detailed docs into module README.md files #67

mogul opened this issue Mar 10, 2025 · 0 comments

Comments

@mogul
Copy link
Contributor

mogul commented Mar 10, 2025

Story

As a developer (or consumer!) of these Terraform modules,
I would like to see details for a given module,
So that I can understand what it deploys and how it works.

Solution

  • Create a README.md in each module, move the top-level README's usage documentation to them, and link to the new location from a summary in the main README
  • Add a Mermaid deployment diagram, similar to this one

Acceptance Criteria

  • One criteria
  • Another criteria
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant