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

"Version" based on the highest (version) tag #10785

Open
buhtz opened this issue Oct 1, 2023 · 6 comments
Open

"Version" based on the highest (version) tag #10785

buhtz opened this issue Oct 1, 2023 · 6 comments
Labels
Needed: more information A reply from issue author is required Support Support question

Comments

@buhtz
Copy link

buhtz commented Oct 1, 2023

What's the problem this feature will solve?

Using RTD with a repository following the OneFlow branching model where there is only one branch. The latest commit in that branch reflects the latest development state (possible unstable) and the highest v* tag is the latest stable version.

Describe the solution you'd like

The "stable" version on RTD should not follow a specific branch or a specific tag. But it should look for the highest tag based on a pattern like v*.
For example you can get the highest tag (without a pattern ) on bash via git with git -C $REP_URL describe --tag --abbrev=0

Additional context

Keep in mind this is useful for repos having only one branch but having the need of the two (usual) docu version stable and latest/unstable.

@stsewd
Copy link
Member

stsewd commented Oct 2, 2023

Hi, we already do this automatically, if you build your docs, you'll get two versions, latest and stable, latest points to the main/master branch (can be changed to point to any other branch or tag), and stable points to the mayor version tag sorted by SemVer.

@stsewd stsewd added Support Support question Needed: more information A reply from issue author is required labels Oct 2, 2023
@buhtz
Copy link
Author

buhtz commented Oct 3, 2023

and stable points to the mayor version tag sorted by SemVer.

Never noticed that. Nice to know. It is totally unclear from using the UI.
I would say there is room for improvement.

The current UI suggest that everything is build based on branches or specific tags. Nowhere tag-patters or SemVer are mentioned.

@stsewd
Copy link
Member

stsewd commented Oct 4, 2023

This is described at https://docs.readthedocs.io/en/stable/versions.html.

@agjohnson thoughts about having some kind of mention of this in the UI?

@agjohnson
Copy link
Contributor

I always prefer to solve UX/UI issues though UI changes, rather than explain our UX with prose content. There's a limit to what users will spend time reading and extra prose content usually clutters the UI more than anything.

To address the UX issue of us not being transparent about these aliases, I still really like the idea of surfacing these as true/mock automation rules. This would help explain these concepts visually and would give us something concrete to link to in the UI even.

We can also be clearer that latest and stable versions are pointers/aliases -- the new dashboard takes a stab at this by labeling the branch/version and the hover popup on the label helps describe things more.

@buhtz
Copy link
Author

buhtz commented Oct 5, 2023

I always prefer to solve UX/UI issues though UI changes, rather than explain our UX with prose content. There's a limit to what users will spend time reading and extra prose content usually clutters the UI more than anything.

I agree here.

We can also be clearer that latest and stable versions are pointers/aliases -- the new dashboard takes a stab at this by labeling the branch/version and the hover popup on the label helps describe things more.

For some new users it might also not be clear that "stable" and "latest" is something different from a branch. Maybe name that more precise "Version "stable"" and "Version "latest"". And behind it a simple text "points to" or "linked to" something like "branch main" or "highest tag pattern v*.." or "Highest version tag based on pattern v*..".

@humitos
Copy link
Member

humitos commented Feb 21, 2024

I always prefer to solve UX/UI issues though UI changes, rather than explain our UX with prose content.

We will be eventually able to use the same algorithms we are going to use to sort the versions in the flyout (as @stsewd suggested in #11069), where the pattern is also customizable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required Support Support question
Projects
None yet
Development

No branches or pull requests

5 participants
@humitos @agjohnson @stsewd @buhtz and others