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

"latest-release" URLs #68

Open
ceceliadid opened this issue Jan 23, 2020 · 13 comments
Open

"latest-release" URLs #68

ceceliadid opened this issue Jan 23, 2020 · 13 comments
Labels
post release issues that will be fixed after the release

Comments

@ceceliadid
Copy link

@arunchawla-NOAA @rsdunlapiv @ligiabernardet @climbfuji @junwang-noaa It would be tremendously useful to define URLS for the "last_release" of code and documentation for the app, the weather model, and utilities like nceplibs, as soon as possible. The definition would get updated with each new release. This was incredibly useful to ESMF over the years from a communicatoin point of view because it meant that you could create websites and documents that were far easier to maintain, if the specific version # for the reference did not matter that much. It would be very helpful to have this ready for pre-release graduate student testing.

@arunchawla-NOAA
Copy link
Collaborator

arunchawla-NOAA commented Jan 23, 2020 via email

@ceceliadid
Copy link
Author

I think you need to have something that looks like a candidate tag for the weather model, nceplibs, and the associated WM UG documentation by the end of this month. We need these to do to the weather model GST. Create the last_release structure and for now point it to those candidate tags. When you have the actual release, you update the last_release tag with the new values.

@arunchawla-NOAA
Copy link
Collaborator

arunchawla-NOAA commented Jan 23, 2020 via email

@ceceliadid
Copy link
Author

Well, you already have a branch called ufs_public_release so I think if people were going to get confused by what you name things in the repo they would have already.
The model and app wikis say "this repository is not yet ready for general use" and I think about a billion people have been told that the release is upcoming but not out yet. It really seems ok to do this to me and a month before the release the right timeframe to get it ready. That way we can use it for the documents and web pages we need to create.

@junwang-noaa
Copy link

junwang-noaa commented Jan 24, 2020 via email

@ceceliadid
Copy link
Author

@junwang-noaa I agree that the beta tags are just for internal and GST testing, not for public announcement. The public mostly doesn't need to think about the last_release structure, that is just a huge convenience for document and website maintenance.

@ligiabernardet
Copy link
Collaborator

The release codes (beta versions and actual release versions) should be tagged. We can use use ReadTheDocs to display multiple releases, latest release, and top of development (auto-updating). You can see a prototype of that in the ReadTheDocs for the CCPP Technical documentation. On the lower right there is a button to choose the various releases (https://ccpp-techdoc.readthedocs.io/en/latest/).

@ceceliadid
Copy link
Author

That looks perfect.

@ceceliadid
Copy link
Author

@arunchawla-NOAA Is there a plan for when these latest_release tags would be going on the code and documentation?

@ceceliadid ceceliadid changed the title "last_release" URLs "latest-release" URLs Mar 1, 2020
@arunchawla-NOAA
Copy link
Collaborator

@ceceliadid how did we want these tags to look? And should we just tag the weather app as the model is called from it? Are the library builds mentioned there?

@ceceliadid
Copy link
Author

@arunchawla-NOAA @llpcarson @ligiabernardet I would suggest seeing if v1.0.0 tags are going to be moved in the UGs for anything else and deal w/this on Monday. I see places where it would be useful to have this, but at this point it's probably better to wait for the first patch releases. I don't want to change the wikis or Portal for this now. The proposal was ufs-latest-release or latest-release only on the WM, app, and NCEPLIBS/NCEPLIBS-external.

@ceceliadid ceceliadid added the post release issues that will be fixed after the release label Mar 8, 2020
@ligiabernardet
Copy link
Collaborator

ligiabernardet commented Mar 8, 2020 via email

@ceceliadid
Copy link
Author

My preference would be to keep it open so it can be done before it gets forgotten. I put a post release tag on it - it seems like a good time to start identifying some of those issues. It should be pretty quick and easy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
post release issues that will be fixed after the release
Projects
None yet
Development

No branches or pull requests

4 participants