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

[Minor Chores] Test out GH Forms for Issues / Pull Requests, Mermaid Graph Updates #69

Closed
Cameronsplaze opened this issue Nov 14, 2024 · 2 comments · Fixed by #82
Closed
Labels
enhancement New feature or request

Comments

@Cameronsplaze
Copy link
Owner

Test out GH Forms for Issues / Pull Requests
When using aws_cdk, I noticed they had a special form you fill when filling out issues. It looks nice, look at changing to that here! (Same with the "Add your +1 👍 to help us prioritize..." line, and things like that).

Also remove the custom issue template, there's a link to a blank one at the bottom.

Mermaid Graph Updates
Turns out Mermaid supports sub-graphs! It's hard to find solid docs on doing this though. But if you combine these two:

@Cameronsplaze Cameronsplaze added the enhancement New feature or request label Nov 14, 2024
@Cameronsplaze
Copy link
Owner Author

Cameronsplaze commented Nov 25, 2024

To include in doc re-write:

  • Estimated Cost Calculator for Everything
  • What the other 2 alarms do, and enabling the "up for too long" alarm specifically (it's the one that doesn't trigger by default)
    • Maybe move the FAQ alarm into it's own section, with these two?
  • Split Maturity and Container-id into two different sections. (Maybe three, with config-file). Basically re-organize that section

@Cameronsplaze
Copy link
Owner Author

Also, look at updating the Examples/README.md to allow linking to each param. I e maybe something like:

### Watchdog (Dict)

Info

#### Watchdog.Threshold (int)

Info
...
### Volumes[*] (list)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant