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

Use next instead of pre-release display label #642

Closed
davsclaus opened this issue Oct 7, 2021 · 7 comments
Closed

Use next instead of pre-release display label #642

davsclaus opened this issue Oct 7, 2021 · 7 comments
Assignees

Comments

@davsclaus
Copy link
Contributor

We have latest / pre-release today as indicator for the next version.

If we use pre-release then we have to keep updating the version, and the display is long.
Instead we can just use next which is what we mean. The next upcoming version.

@djencks
Copy link
Contributor

djencks commented Oct 7, 2021

I like the idea of changing the display-version to include "next" rather than a concrete version, and I think it would also make sense to change the version to next, so that will show up in URLs. Doing this may also detect anything still linking to "latest" :-)

Although "next" has some implications of "prerelease", I think it is a bad idea to leave out the (prerelease) without doing anything else. Antora calculates the latest version as "latest version that isn't a prerelease". Therefore, in xrefs from other components, if we leave out the version, it will link to the last released version. Including the "(prerelease)" in the display version will make it clear to those familiar with Antora that this version will not be linked to.

Alternatively perhaps we could add an attribute in the component descriptor

prerelease: WARNING: This version is not yet released and should not be used in production

and at the top of every page

{prerelease}

and when we branch set the attribute to blank so this warning doesn't appear

@djencks
Copy link
Contributor

djencks commented Oct 19, 2021

I'd like to implement this soon, over all camel subprojects:

  • change version from latest to next
  • mark next prerelease
  • set display_version to Next or Next (Prerelease)

I've decided I slightly prefer Next (Prerelease) but if that seems to long to others I'm fine with just Next

I expect this will flush out a lot of incorrect xrefs that use the latest version name.

@djencks
Copy link
Contributor

djencks commented Oct 20, 2021

Changing the version to 'next' is going to affect .htaccess, we'll need to redirect from /latest/ to /next/.
Did the old website have only the equivalent of today's 'latest, prerelease' version? I'm not very comfortable directing people by default to the prerelease version, but I suppose if that is what they were viewing on the old website it's OK.

@djencks
Copy link
Contributor

djencks commented Oct 20, 2021

As part of this I plan to make the manual into an unversioned component, which will remove the 'latest' version segment from the urls. This also will need a rewrite rule in .htaccess.

@djencks
Copy link
Contributor

djencks commented Oct 25, 2021

PRs for this:
#654

camel:

camel-spring-boot
main-latest-to-next apache/camel-spring-boot#397

camel-quarkus

camel-karaf

camel-kafka-connector

camel-k

camel-k-runtime

camel-kamelets

@davsclaus
Copy link
Contributor Author

Did you forget Camel 3.7.x LTS branch from the core camel project?

@djencks
Copy link
Contributor

djencks commented Oct 27, 2021

I had already fixed the problems there :-)
I think we can close this now.

@djencks djencks closed this as completed Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants