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

docs: support versioned docs #3061

Open
1 task
nitrocode opened this issue Jan 27, 2023 · 3 comments
Open
1 task

docs: support versioned docs #3061

nitrocode opened this issue Jan 27, 2023 · 3 comments
Labels
docs Documentation feature New functionality/enhancement Stale

Comments

@nitrocode
Copy link
Member

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.

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.

@nitrocode nitrocode added feature New functionality/enhancement docs Documentation labels Jan 27, 2023
@Moncky
Copy link

Moncky commented Feb 1, 2023

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

@brandon-fryslie
Copy link

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!

@jamengual
Copy link
Contributor

jamengual commented Jul 20, 2023 via email

@dosubot dosubot bot added the Stale label Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation feature New functionality/enhancement Stale
Projects
None yet
Development

No branches or pull requests

4 participants