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

[ENH] Add Version Dropdown Select Element in Menu Tree #48

Open
thabaum opened this issue Feb 11, 2024 · 4 comments
Open

[ENH] Add Version Dropdown Select Element in Menu Tree #48

thabaum opened this issue Feb 11, 2024 · 4 comments

Comments

@thabaum
Copy link
Contributor

thabaum commented Feb 11, 2024

Enhancement Request

Description

Considering the major shifts that can occur between different versions of our project, it would be beneficial to add a version dropdown select element in the menu tree. This would allow users to focus on the specific version they are working on, similar to the system used by Microsoft.

Benefits

  • Improved user experience: Users can easily navigate and focus on the version they are working on.
  • Reduced confusion: Helps prevent confusion that can arise from differences between versions.
  • Future-proof: While it may be challenging to implement for all older versions, this feature could provide long-term benefits.

Implementation

The implementation of this feature may require significant changes to the menu tree structure and the way we handle documentation for different versions. We need to ensure that the correct documentation is displayed based on the selected version.

Additional Information

image

We could also setup our tree to follow MS with Overview, Get Started, What's New, Tutorials, Fundamentals.

https://learn.microsoft.com/en-us/aspnet/core/?view=aspnetcore-8.0

This link maybe is what our docs homepage could look similar to: https://learn.microsoft.com/en-us/aspnet/core/?view=aspnetcore-8.0

Please share your thoughts on this proposal.

@iJungleboy
Copy link
Collaborator

I believe we should do a version switcher, but not like Microsoft.

Reason is that as the system changes, so do a lot of other docs as well, which become incorrect as time moves on.
So my recommendation is to

  1. archive older versions like Bootstrap does

    1. eg. v5.docs.oqtane.org - similar to https://v16.docs.2sxc.org/
    2. this also allows us to remove them from the google index and freeze docs as they were when they were valid
    3. ...otherwise maintenance later on gets really complex, as we need to generate docs from multiple version of Oqtane
  2. provide a version selector (see top right) for users to switch versions
    image

  3. provide a redirector to go to other versions home OR the same path as they came from

This is the exact setup I created for 2sxc a few months ago, and I think it would fit well.

If you agree, I think I could get it up an running in ca. 3h

@thabaum
Copy link
Contributor Author

thabaum commented Feb 22, 2024

@iJungleboy Hope all has been well. Sorry to not get back to you in a timely manner here as I was assisting with the Oqtane migration to Blazor Web App. Your solution should work OK. Oqtane uses 5.0.0 and 5.1 for example can be a big change. so for our versioning I think v5x.docs.oqtane.org for example if not v5xx.docs.oqtane.org should be enough for major changes which usually need to be documented or however Bootstrap does it. For example would we use v5, v4 for base version, and v5.1 for the big change if one happens, since this is not always the case?

Just curious how this will be, I am sure it will be all thought out for the best of maintaining it from your past experiences.

We should make a push before the 5.1 documentation is needed and look at community questions for ideas for adding to the concepts, guides and so on. v5.1 should be prepared for release I am guessing pretty soon. We can see what we can get done between now and over the weekend to accomplish some things like this prior to release of 5.1 docs and upcoming docs meeting. This will ensure we all hit the road running next month. 🚀

@iJungleboy
Copy link
Collaborator

For v5.1 we have to see.

I'm guessing that 5.1 could be a breaking change - in which case it should be semantically 6.0, but I don't know the details or Shauns strategy. So we'll see.

@sbwalker
Copy link
Member

sbwalker commented Feb 23, 2024

@iJungleboy 5.1 is not a breaking change see:

oqtane/oqtane.framework#3874

@thabaum thabaum changed the title Enh: Add Version Dropdown Select Element in Menu Tree [ENH] Add Version Dropdown Select Element in Menu Tree Oct 15, 2024
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

3 participants