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

Add Patch level version to Get Started Guide #4678

Open
berndruecker opened this issue Nov 28, 2024 · 4 comments
Open

Add Patch level version to Get Started Guide #4678

berndruecker opened this issue Nov 28, 2024 · 4 comments
Labels
component:docs Documentation improvements, including new or updated content

Comments

@berndruecker
Copy link
Member

In this guide: https://docs.camunda.io/docs/next/guides/getting-started-java-spring/ (https://github.com/camunda/camunda-docs/edit/main/docs/guides/getting-started-java-spring.md) we need to enter the right patch level so that users can easily copy paste without searching for a version number (which they might not know how).

Of course that means it needs to be updated when we release a patch version.

@akeller These are the small details I find important for a rock star developer experience

image

@berndruecker
Copy link
Member Author

Even when I know how to search for versions - I can still get confused (do I use the alpha? What's a rc? ..?). No complex decisions - but it carries me away from what I wanted to do: Run a Camunda app as quickly as possible

image

@berndruecker
Copy link
Member Author

I had the same problem also on other pages - e.g. https://docs.camunda.io/docs/next/apis-tools/testing/getting-started/
I think we should find a way to have the right version numbers everywhere - always up-to-date. Maybe there is some Bot that can do that - otherwise a grep statement should find the right places to adjust on new releases at least.

And I would generally prefer to see 8.5.0 there and probably not the latest patch-level instead of not seeing any version number.
But of course I would prefer to always see the latest patch level up-to-date (8.5.6) :-)

@akeller akeller added the component:docs Documentation improvements, including new or updated content label Dec 4, 2024
@akeller
Copy link
Member

akeller commented Dec 4, 2024

Of course that means it needs to be updated when we release a patch version.

@berndruecker We (DevEx) don't have great visibility into patch releases, just alphas and minors, so while I agree this should be updated, we would need to bake this update into the patch release process. If adding .0 would be sufficient, this would be a quick win.

@akeller
Copy link
Member

akeller commented Dec 12, 2024

@mesellings, based on your comment on this PR, you may want to chime in on this thread.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Status: 🆕 Inbox
Development

No branches or pull requests

2 participants