Replies: 3 comments
-
Hey @Y0RI0 , It's a good idea, and we've talked about implementing something like this after 1.0. The problem that we're running into is that we're a small team, and it would be prohibitively expensive to maintain multiple versions of the Terragrunt docs right now. This might change in the future after 1.0, as things stabilize more, but until then we are choosing to maintain a single source of truth for how Terragrunt works (as of the latest version), and migration docs to help users migrate to the latest version. Feedback welcome! |
Beta Was this translation helpful? Give feedback.
-
Thank you @yhakbar, I appreciate your response and understand it would be prohibitively difficult at the current time. No other feedback for now other than that which is written, but thank you for reaching out and I look forward to the 1.0 release in this case 🙏 |
Beta Was this translation helpful? Give feedback.
-
Sounds good! I'll move this issue to a discussion if anyone has any other feedback, as it's not immediately actionable. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Describe the enhancement
Currently the terragrunt documentation, and website visual presentation are changing at rapid pace. For those using terragrunt in an organization the pace of changes is much faster than most orgs can keep up with as far as being on latest terragrunt. Please do something (akin to how hashicorp or opentofu have module version documentation history) to maintain a visual paper trail of your version to version changes so that those using an older version at the moment can understand the differences between the version they are currently running and the latest terragrunt version.
Edit:
I understand that CLI commands are actually changing and might not be the same between versions, but on affected features then there should at least be some information about where those features were moved to and how to use new ones on the same page of documentation for the flag, not somewhere else on a notice page or a version release tag. Similarly to how providers will include information in their documentation for a resource about deprecated attributes and what to use instead.
Also, this would help people when they are upgrading versions to correlate their current config against the changes as well. Otherwise, there is a lot of effort to dig through version tag changelogs to see what current flags have been transformed into in newer versions.
Additional context
The only best way right now to look at older versions of terragrunt documentation are on random 3rd party sites, which is both not sustainable and not reliable.
Example:
https://fig.io/manual/terragrunt/validate
PoC (Proof of Concept)
Link to a Proof of Concept if you have one:
Something roughly like this, but for terragrunt changes would be ideal, in cases where possible:
https://search.opentofu.org/provider/hashicorp/aws/latest
RFC Not Needed
Beta Was this translation helpful? Give feedback.
All reactions