Open nitrocode opened 1 year ago
Just ran into this. Speficially with the state_rm functionality https://www.runatlantis.io/docs/using-atlantis.html#atlantis-state-rm which is currently showing on the docs page and is part of the as yet unscheduled 0.23.0 release
First of all, love Atlantis, you guys rock. I really appreciate what you're doing.
Here's the problem. It's extremely challenging for Atlantis users to know which features are available. At minimum the flags should say "introduced in version XYZ". I'm using Atlantis for more than "hobbyist" level work which means I can't arbitrarily upgrade to the newest version all the time. Unfortunately it seems like there isn't really a good way to tell what features I can use beyond trying them or reading thru the changelog a few times (which I've done, but not memorized).
I think this would be useful, thanks!
Totally agree, it will be nice to tight the version to the flag/option, maybe we could at least ask the contributor to add a link to the PR and from there the user can figure out very easily what release was that PR merged into.
On Thu, Jul 20, 2023 at 3:50 PM Brandon Fryslie @.***> wrote:
First of all, love Atlantis, you guys rock. I really appreciate what you're doing.
Here's the problem. It's extremely challenging for Atlantis users to know which features are available. At minimum the flags should say "introduced in version XYZ". I'm using Atlantis for more than "hobbyist" level work which means I can't arbitrarily upgrade to the newest version all the time. Unfortunately it seems like there isn't really a good way to tell what features I can use beyond trying them or reading thru the changelog a few times (which I've done, but not memorized).
I think this would be useful, thanks!
— Reply to this email directly, view it on GitHub https://github.com/runatlantis/atlantis/issues/3061#issuecomment-1644738035, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAQ3EREHUZKUDRNLNGHILHLXRGY2XANCNFSM6AAAAAAUIX35NI . You are receiving this because you are subscribed to this thread.Message ID: @.***>
Community Note
Describe the user story
If a pr of a new feature gets merged, the pr would make it into the next release, however the documentation would be updated immediately. This would make it seem like the feature is available in the current version which is not the case.
Describe the solution you'd like
Use versioned docs
See issue
Describe the drawbacks of your solution
More effort which will result in more clarity
Describe alternatives you've considered
Adding the version of each feature as markdown. We do this now every now and then. Sometimes we forget. It's inconsistent.