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.

Sign up for GitHub

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

Jump to bottom

Unclear which version is referred to by stable: add stable version number visibly #817

Closed
corneliusroemer opened this issue Dec 16, 2021 · 2 comments · Fixed by nextstrain/sphinx-theme#16
Closed

Unclear which version is referred to by stable: add stable version number visibly #817

corneliusroemer opened this issue Dec 16, 2021 · 2 comments · Fixed by nextstrain/sphinx-theme#16
Labels
documentation Improvements or additions to documentation priority: low To be resolved after high and moderate priority issues

Comments

@corneliusroemer
Copy link
Member

Our documentation default seems to be stable, at least when I google.

However, I can't figure out which version stable corresponds to. It'd be good if we added that information somewhere.

Then people using Augur could also immediately see if they're not using the latest version.

image
@corneliusroemer corneliusroemer added the documentation Improvements or additions to documentation label Dec 16, 2021
@huddlej
Copy link
Contributor

huddlej commented Dec 22, 2021

I can see the potential for confusion here, but this seems to be a RTD UI issue. The "stable" label depends on RTD's parsing of versioned documentation where they assume we use semantic versioning and assign the "stable" label to the latest release.

We could explicitly state somewhere in the docs that "stable" is always the latest release, but I'm not sure where to put that where it would be consistently seen. Maybe in the footer?

@corneliusroemer corneliusroemer mentioned this issue Dec 23, 2021
Open
@corneliusroemer
Copy link
Member Author

There's already an issue upstream in RTD issue tracker, but it seems stale and the problem unresolved - quite surprisingly really, this does seem like quite a problem to me as a user.

SciTools/iris figured out a workaround. Not sure whether this is important enough for us to apply - or maybe we just tag it blocked and wait for upstream to fix it at some point?

readthedocs/readthedocs.org#4529 (comment)

@huddlej huddlej added blocked Dependent on external development priority: low To be resolved after high and moderate priority issues labels Dec 23, 2021
@huddlej huddlej mentioned this issue Jan 27, 2022
Merged
tsibley added a commit to nextstrain/sphinx-theme that referenced this issue Jan 28, 2022
@tsibley
Show precise versions for stable and development ("latest")
ffac8ee 
Make it even clearer what software revisions those labels represent.

A `git describe` style string¹ for development ("latest") would be even
better than just the git revision, but that appears to be non-trivial to
implement.

Resolves <nextstrain/augur#817>.

h/t to @corneliusroemer for the suggestion and @huddlej for bringing it
up again in <#15>.

¹ e.g. "${tag}-${n}-g${sha}" where ${tag} is the last/closest tag to the
  current commit, ${n} is the number of commits since that ${tag}, and
  ${sha} is the shortened id of the current commit.
@tsibley tsibley mentioned this issue Jan 28, 2022
Merged
@victorlin victorlin removed the blocked Dependent on external development label May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation priority: low To be resolved after high and moderate priority issues
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Show precise versions for stable and development ("latest") nextstrain/sphinx-theme
3 participants
@huddlej @victorlin @corneliusroemer