Plan to put final tags on and make sure tags and links are correct in all documentation

[ceceliadid]

We need a plan to put the final tags on (v1.0.0 and latest_release) and review to make sure the NCEPLIBS, WM, and app documentation has the correct links throughout.

[ceceliadid]

For example, currently I see the app UG pointing to all the "latest" versions of documentation, which needs to be changed.

[ligiabernardet]

Yes, this is in my radar. But we need the final tags to be created first. Need a status update of that.

On Thu, Feb 27, 2020 at 8:13 AM ceceliadid notifications@github.com wrote:

For example, currently I see the app UG pointing to all the "latest" versions of documentation, which needs to be changed.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/ufs-community/ufs-mrweather-app/issues/105?email_source=notifications&email_token=AE7WQAS5GX6A3SUVNMRX6CLRE7KCPA5CNFSM4K45AEDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENEWZTI#issuecomment-592014541, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE7WQAUJIFJE2HYWMKD4TG3RE7KCPANCNFSM4K45AEDA .

[llpcarson]

The following documentation pages need to be configured to point to the static (non-updating) release tag in readthedocs.

https://ufs-mrweather-app.readthedocs.io/en/ufs-v1.0.0 https://ufs-utils.readthedocs.io/en/ufs-v1.0.0 https://ufs-weather-model.readthedocs.io/en/ufs-v1.0.0 https://ccpp-techdoc.readthedocs.io/en/v4.0.0 https://stochastic-physics.readthedocs.io/en/ufs-v1.0.0 https://upp.readthedocs.io/en/ufs-v1.0.0

Once these tags and versions are ready, we'll update the MRWeather Users Guide to reflect the release versions of the documents.

Cecelia - do all of these also need "latest_release" versions? or, just the top-level docs (referenced externally)?

[fossell]

UPP tag ufs-v1.0.0 has been built and is available (https://upp.readthedocs.io/en/ufs-v1.0.0/)

[ceceliadid]

@llpcarson my proposal was that we put ufs-latest-release on ufs weather model, ufs medium range weather app, and nceplibs/nceplib-external and make sure the practice is useful and working well. We can always expand the usage later if we want. @arunchawla-NOAA are you okay wth that?

[llpcarson]

Sounds good to me - since the NCEPLIBS (and -externals) docs are all on the github wikis and in README's, there isn't a readthedocs version needed (but a repository tag)

Laurie

On Wed, Mar 4, 2020 at 11:00 AM ceceliadid notifications@github.com wrote:

@llpcarson https://github.com/llpcarson my proposal was that we put ufs-latest-release on ufs weather model, ufs medium range weather app, and nceplibs/nceplib-external and make sure the practice is useful and working well. We can always expand the usage later if we want. @arunchawla-NOAA https://github.com/arunchawla-NOAA are you okay wth that?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ufs-community/ufs-mrweather-app/issues/105?email_source=notifications&email_token=AB2OWIUQOCTHSRZWB3LYBLTRF2JNFA5CNFSM4K45AEDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENZI57Y#issuecomment-594710271, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB2OWIUK7KUTQC3LZYFRK3DRF2JNFANCNFSM4K45AEDA .

[ligiabernardet]

I believe we also need to settle on the final URLs for the NEMS and FV3 dycore documentation. NEMS is currently at https://noaa-emc.github.io/NEMS_doc/index.html. Should this be https://noaa-emc.github.io/NEMS_doc_ufs-v1.0.0/index.html? FV3 is at https://noaa-emc.github.io/FV3_Dycore_v1.0/html/index.html. Should this be https://noaa-emc.github.io/FV3_Dycore_ufs-v1.0.0/html/index.html?

[arunchawla-NOAA]

@MinsukJi-NOAA and @valbonakunkel-noaa can we move the NEMS_doc and the FV3_dycore docs in these places? We should do it by hand so that this version gets frozen and the automatic update then goes to the regular place.

[MinsukJi-NOAA]

NEMS_doc_ufs-v1.0.0 folder was created: https://noaa-emc.github.io/NEMS_doc_ufs-v1.0.0/index.html

[jedwards4b]

Any objections to creating the ufs-v1.0.0 tag on ufs-mrweather-app now?

[climbfuji]

I have not seen any reports of testing on a wide range different platforms other than the work I did (C96 GFSv15p2 only). Can folks please populate https://docs.google.com/document/d/1V86BetD4is9SF-p9C_KMcchGli1moH3BPCTlVyJXMAM/edit?ts=5e60da6f https://docs.google.com/document/d/1V86BetD4is9SF-p9C_KMcchGli1moH3BPCTlVyJXMAM/edit?ts=5e60da6f ? Seems like I have been testing most across platforms.

On Mar 6, 2020, at 10:07 AM, jedwards4b notifications@github.com wrote:

Any objections to creating the ufs-v1.0.0 tag on ufs-mrweather-app now?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/ufs-community/ufs-mrweather-app/issues/105?email_source=notifications&email_token=AB5C2RI2ZQ3TMKW32TVOLGDRGEUW7A5CNFSM4K45AEDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOCDIVA#issuecomment-595866708, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB5C2RKOEDHHMIOSWBL66P3RGEUW7ANCNFSM4K45AEDA.

[ligiabernardet]

DTC is working on app documentation and will do a commit later this afternoon with what could be the final version. However, it would be great if CIME folks and all could take a look at this documentation over the next few days because we always need another set of eyes.

On Fri, Mar 6, 2020 at 10:10 AM Dom Heinzeller notifications@github.com wrote:

I have not seen any reports of testing on a wide range different platforms other than the work I did (C96 GFSv15p2 only). Can folks please populate https://docs.google.com/document/d/1V86BetD4is9SF-p9C_KMcchGli1moH3BPCTlVyJXMAM/edit?ts=5e60da6f < https://docs.google.com/document/d/1V86BetD4is9SF-p9C_KMcchGli1moH3BPCTlVyJXMAM/edit?ts=5e60da6f> ? Seems like I have been testing most across platforms.

On Mar 6, 2020, at 10:07 AM, jedwards4b notifications@github.com wrote:

Any objections to creating the ufs-v1.0.0 tag on ufs-mrweather-app now?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub < https://github.com/ufs-community/ufs-mrweather-app/issues/105?email_source=notifications&email_token=AB5C2RI2ZQ3TMKW32TVOLGDRGEUW7A5CNFSM4K45AEDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOCDIVA#issuecomment-595866708>, or unsubscribe < https://github.com/notifications/unsubscribe-auth/AB5C2RKOEDHHMIOSWBL66P3RGEUW7ANCNFSM4K45AEDA .

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/ufs-community/ufs-mrweather-app/issues/105?email_source=notifications&email_token=AE7WQAQLEIAPVB52VAR6XKLRGEU7HA5CNFSM4K45AEDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOCDQDA#issuecomment-595867660, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE7WQASY476MQXBW7AUMYU3RGEU7HANCNFSM4K45AEDA .

[jedwards4b]

@ligiabernardet It's not entirely clear to me how that works since the ufs-weather-model tag ufs-v1.0.0 has already been created.

[ligiabernardet]

We already finalized the ufs-weather-model documentation. We are currently finalizing the app documentation at https://github.com/ufs-community/ufs-mrweather-app/tree/documentation. We are working on branch documentation. But thi sbranch will have to be merged in before the final tag is created. We will have a stable doc later this afternoon.

On Fri, Mar 6, 2020 at 10:17 AM jedwards4b notifications@github.com wrote:

@ligiabernardet https://github.com/ligiabernardet It's not entirely clear to me how that works since the ufs-weather-model tag ufs-v1.0.0 has already been created.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ufs-community/ufs-mrweather-app/issues/105?email_source=notifications&email_token=AE7WQASXMHBFBHQOP7UIURDRGEV2JA5CNFSM4K45AEDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOCEKDY#issuecomment-595870991, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE7WQAVMTATQODVPUG52DTTRGEV2JANCNFSM4K45AEDA .

[jedwards4b]

@ligiabernardet thanks for clarifying

[ceceliadid]

@ligiabernardet @rsdunlapiv @jedwards4b Could you please send what will be the final URLS for the app code and app UG? What time do you all think these will be ready today?

[ligiabernardet]

Ligia and @llpcarson will have their changes committed by 3 PM. @jedwards4b has additional changes coming in. Then someone need to merge branch documentation onto the main branch. Will @jedwards4b do the merge? It would be great for others to look the documentation before creating the tag. Does @ceceliadid have bandwidth? Code for doc will be in https://github.com/ufs-community/ufs-mrweather-app (master branch, directory doc) URL will be https://ufs-weather-model.readthedocs.io/en/ufs-v1.0.0

[jedwards4b]

@ligiabernardet I can do the merge. Should I plan to make the tag on Monday to give folks the weekend to review the docs?

[ceceliadid]

Thank you, I will start propagating that tag even if the links are broken. I don't think I should spend much time checking docs before the tag, it's probaly best to focus on changes to the website while Bhavana is still around this week. Could someone ( @jedwards ?) please confirm final app code tag?

[ceceliadid]

Sorry, did not mean to close that. @jedwards4b my vote is to please put the tag on this week so we can make changes to the Portal/wikis and check them. For complicated reasons it gets hard to make corrections esp. to the Portal after Monday morning.

[jedwards4b]

I need to make the tag before the docs are finalized but the docs must be finalized before I make the tag? @ceceliadid @ligiabernardet please clarify. The tag name will be ufs-release-v1.0.0

[climbfuji]

Chicken and egg problem! The documentation must be finalized, anticipating a tag named ufs-release-v1.0.0 or whatever the correct name is, and then the tag can be created.

[arunchawla-NOAA]

Jim

Just create the tag. If there are documentation updates we can force the tag creating again. Just to be on the safe side do it just before leaving for the day so we have all the changes in. If we need to address further changes then we will deal with it on Monday.

Sent from my iPhone

On Mar 6, 2020, at 3:55 PM, jedwards4b notifications@github.com wrote:

 I need to make the tag before the docs are finalized but the docs must be finalized before I make the tag? @ceceliadid @ligiabernardet please clarify. The tag name will be ufs-release-v1.0.0

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

[ceceliadid]

@jedwards4b the tag convention is ufs-v1.0.0 not ufs-release-v1.0.0

Please confirm. The full URL for the tagged app code will be: https://github.com/ufs-community/ufs-mrweather-app/tree/ufs-v1.0.0

Correct?

[jedwards4b]

sure

[ligiabernardet]

All, I am fine with creating the tag. W should all know that there will be typos/issues to be found as the people start looking more at the documentation and exercising the code. Just being realistic.

[jedwards4b]

Ladies and gentlemen - the ufs-v1.0.0 tag of the ufs-mrweather-app has been created. Have a nice weekend.

[rsdunlapiv]

Drops mic.