Remove the version dropdown via CSS

[sdelamo]

I think we should remove the dropdown in the HTML since it is causing more confusion than benefit.

I suggest we remove it via CSS.

@micronaut-projects/core-developers thoughts?

[wetted]

This will always point to LATEST? What if someone is stuck on Micronaut 3 and needs docs for that? They just need to know to change the docs URL?

[burtbeckwith]

What confusion?

[andriy-dmytruk]

Perhaps latest/snapshot should also include the actual version, e.g. 4.0.0 (Latest)?

[alvarosanchez]

I find it useful. What is the confusion that it causes?

[sdelamo]

Since Micronaut Framework 4, the framework version is not the core version. The people see 4.3.2 in the main docs (the core documentation) and they expect a version of the framework of 4.3.2. and that may not exists. In general, people should always go to latest unless they want to go a previous major version of the docs which they can change via the URL.

[sdelamo]

Moreover, we have issues with the drop down getting out of sync and just showing latest and snapshot.

I have to manually fix it via this script.

[melix]

I'm fine with removing the dropdown. If we decide to go this route it requires changes in micronaut-build which has tasks to deal with it.

[alvarosanchez]

Oh, you meant the core version...

I would agree to remove it only from core docs. But for the modules I still find it useful

[sdelamo]

Oh, you meant the core version...

I would agree to remove it only from core docs. But for the modules I still find it useful

I mean for every module. But core causes the most confusion.

[sdelamo]

I'm fine with removing the dropdown. If we decide to go this route it requires changes in micronaut-build which has tasks to deal with it.

I assume we need a release of docs with the css changes.

[melix]

Not necessarily, we can change the release dropdown task, which is simply post-processing the HTML, to remove that section, possibly as an option.

[osscontributor]

If the drop down is removed, can we provide a page or nav bar or something that lists versions of Micronaut Platform that have been released and links to the docs for the version of the User Guide that corresponds to the version of core that that version of Micronaut Platform depends on by default?

[osscontributor]

The people see 4.3.2 in the main docs (the core documentation) and they expect a version of the framework of 4.3.2. and that may not exists.

I agree that causes confusion.

Personally, I like the drop down but I wish that the version numbers scheme was such that the version of Micronaut Platform that I am using is the version I should select in that list. Folks often don’t necessarily know what version of core they are using because they don’t necessarily ever specify that version number or see it anywhere. They do know the version of platform they are using.

If I install micronaut using SdkMan and I install it with “sdk install micronaut 3.8.9” 3.8.9 is the version of Platform I am installing, not necessarily the version of core I will be using, and when I want to use it I do that with “sdk use micronaut 3.8.9”. When I go to reference the User Guide for that I would expect to go to version 3.8.9 of the User Guide. For some of our releases the platform version and the core version happen to the be the same and for some they don’t.

I like the idea of being able to easily find docs for the version of Micronaut that I installed.

[osscontributor]

If the drop down is removed, can we provide a page or nav bar or something that lists versions of Micronaut Platform that have been released and links to the docs for the version of the User Guide that corresponds to the version of core that that version of Micronaut Platform depends on by default?

Just re-raising that question. Thank you for your feedback!

[sdelamo]

We could generate a version of https://docs.micronaut.io/index.html with links to the docs versions of particular platform release.

and generate a index431.html and index430.html etc per release. index.html would be always the latest stable release.

So the link of the user guide for core will point to

Instead of https://docs.micronaut.io/latest/guide the link will be https://docs.micronaut.io/4.3.5/guide/

Instead of https://micronaut-projects.github.io/micronaut-data/latest/guide/ the link will be https://micronaut-projects.github.io/micronaut-data/4.6.1/guide/index.html

[osscontributor]

If I understand that correctly, I think that sounds good. What I think would be helpful is if I know the version of platform that I am using (I think that is the version number that most folks think about when they think about what version of Micronaut they are using) then I would like to be able to navigate to the docs for the version of core that is configured by default in a newly created Micronaut app for that version of platform.

[osscontributor]

Would there be a navbar or page that lists released versions of platform and provide links to the docs for the version of core that is configured by default for that version of platform?

[sdelamo]

If I understand that correctly, I think that sounds good. What I think would be helpful is if I know the version of platform that I am using (I think that is the version number that most folks think about when they think about what version of Micronaut they are using) then I would like to be able to navigate to the docs for the version of core that is configured by default in a newly created Micronaut app for that version of platform.

if you are using MN 4.3.4, then you will navigate to https://docs.micronaut.io/4.3.4.html and you will get a link to to core 4.3.9.

Would there be a navbar or page that lists released versions of platform and provide links to the docs for the version of core that is configured by default for that version of platform?

The page which lists releases of platform already exists:

https://github.com/micronaut-projects/micronaut-platform/releases

We can add a link from each of those releases to the docs page. e.g. from 4.3.4 release a link to https://docs.micronaut.io/4.3.4.html

We can also, try to add a dropdown to in docs.micronaut.io to go change the version.

[osscontributor]

We can also, try to add a dropdown to in docs.micronaut.io to go change the version.

Thank you!

[timyates]

I believe this is done 👍