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

Make a v2.8.0 release of the UserGuide #397

Open
IAlibay opened this issue Nov 27, 2024 · 9 comments
Open

Make a v2.8.0 release of the UserGuide #397

IAlibay opened this issue Nov 27, 2024 · 9 comments
Assignees

Comments

@IAlibay
Copy link
Member

IAlibay commented Nov 27, 2024

With MDAnalysis v2.8.0 now out, a new release of the UserGuide should be made.

@orbeckst
Copy link
Member

A 2.8.0 version is out (PR #398 ?)

@IAlibay
Copy link
Member Author

IAlibay commented Dec 19, 2024

@orbeckst re-opening, the userguide v2.8.0 was not released - see the lack of tags for the release.

@IAlibay IAlibay reopened this Dec 19, 2024
@RMeli
Copy link
Member

RMeli commented Dec 19, 2024

#398 was the first few steps towards a release. Should I make a release without the guessers? If yes, I can take care of this tomorrow or over the weekend (I already botched a release today, so not tempting fate tonight...)

@IAlibay
Copy link
Member Author

IAlibay commented Dec 19, 2024

We have several folks asking for docs on the new Guessers, it would be nice for the 2.8.0 version of the userguide to have those details. However it's really up to y'all.

@orbeckst
Copy link
Member

orbeckst commented Dec 19, 2024

Then I am thoroughly confused by what you mean by "Release of the UG", given that https://userguide.mdanalysis.org/2.8.0/ is clearly available.

(EDIT: I see that the UG has its own release https://userguide.mdanalysis.org/2.8.0/preparing_releases_and_hotfixes.html#create-a-release-of-the-userguide — I just still don't see its relevance from a user perspective.)

@IAlibay
Copy link
Member Author

IAlibay commented Dec 19, 2024

@orbeckst it looks like the release process got broken and/or someone changed something - the way it's meant to be is that until you push tags you have a 2.8.0-dev0 branch on dev and a 2.7.0 on stable. So the user facing "latest" would just show 2.7.0.

It looks like the somehow that's no longer happening, not sure what happened there 🤷🏽‍♂️

@orbeckst
Copy link
Member

ok, thanks for the explanation

@IAlibay
Copy link
Member Author

IAlibay commented Dec 20, 2024

Ah ok I know what went wrong here @orbeckst - the issue was that a 2.8.0 version of the docs got released during the time that we were on a feature freeze.

If you look at the docs for the 2.8.0 page (for example the changelog page that @RMeli recently updated) they are not up to date! https://userguide.mdanalysis.org/2.8.0/releases.html

There should be a 2.8.0 changelog entry in there but it only goes to 2.7.0.

@IAlibay
Copy link
Member Author

IAlibay commented Dec 20, 2024

What we'll want to do here is:

  • clean up the 2.8.0 entry from the gh-pages branch
  • when we're ready for a new release, push a new tag and let that build a new version of the docs

Alternatively you can skip directly to pushing new tags if you don't want to update the guessers docs first.

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

4 participants