docs: improve documentation with guides, tutorials and examples #78
Conversation
|
First of all, thank you for your contribution during Hacktoberfest! We appreciate it! Meanwhile, some of this MR a is duplicated of another one: #74, in case you also want to take a look at it and give your opinion |
|
|
||
| ## Contributing | ||
|
|
||
| Found an issue or want to add more examples? Contributions welcome. |
There was a problem hiding this comment.
Typo: replace Contributions welcome. for Contributions are welcome!
| @@ -1,12 +1,55 @@ | |||
| # Terraform Provider Tsuru [](https://github.com/tsuru/terraform-provider-tsuru/releases) []() | |||
| # Terraform Provider Tsuru - Improved Documentation | |||
There was a problem hiding this comment.
Not sure if the text - Improved Documentation is necessary. If we merge this will be the only documentation.
| - Usage | ||
| - [Provider Documentation](https://registry.terraform.io/providers/tsuru/tsuru/latest/docs) | ||
| - [Tsuru Documentation](https://docs.tsuru.io/) | ||
| Better docs for the terraform-provider-tsuru with practical examples, migration guides, detailed resource documentation, and step-by-step tutorials. |
There was a problem hiding this comment.
Could be Documentation for the .... in place of Better docs ...
| "CACHE_URL" = "redis://host:port" | ||
| } | ||
|
|
||
| no_restart = false |
There was a problem hiding this comment.
looking the terraform resource, I think the tag should be called restart_on_update
https://registry.terraform.io/providers/tsuru/tsuru/latest/docs/resources/app_env
| target = "80%" | ||
| } | ||
|
|
||
| schedules = [ |
There was a problem hiding this comment.
The field schedules seems to be not functional, check the docs for clarification
https://registry.terraform.io/providers/tsuru/tsuru/latest/docs/resources/app_autoscale
| command = ["echo", "Hello from Tsuru Job!"] | ||
| } | ||
|
|
||
| schedule = "@every 1h" |
There was a problem hiding this comment.
I am not familiar with this tag. Maybe we should have 0 */1 * * *
| } | ||
| } | ||
| pools = ["pool1", "pool2"] |
There was a problem hiding this comment.
3 participants
What I added
Migration guide - If you're already using Tsuru and want to start managing it with Terraform, this walks you through it. Covers how to import your existing stuff without breaking anything.
Tutorials
Real examples
Rewrote some resource docs - The app and cluster docs now have actual examples instead of just the schema. Added troubleshooting tips too.
Why
Right now the docs are mostly auto-generated schemas. Hard to figure out how things actually work. These changes should make it way easier to get started and understand how to use the provider.
Let me know if you want me to change anything!