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

Add release strategy to community documentation #1809

Merged
merged 4 commits into from Sep 21, 2020
Merged

Conversation

zklaus
Copy link
Contributor

@zklaus zklaus commented Sep 9, 2020

This adds the release strategy as discussed in the core team.

Please feel free to make further comments and suggestions before we fully commit to this strategy by merging it into master!

@nielsdrost, could you please let me know when you are done with the figure or just add it to this PR?

NB: If adopted, the next feature freeze is scheduled for 2020-10-05 and the next release will be overseen by @valeriupredoi, so I propose to merge this within the next two weeks if possible.

@zklaus
Copy link
Contributor Author

zklaus commented Sep 9, 2020

I added the people that were in the video call or had expressed interest in it as well as the PIs as reviewers.

However, in the spirit of an open community, everyone is welcome to comment.

@bouweandela
Copy link
Member

Thanks @zklaus! @ESMValGroup/esmvaltool-developmentteam Any comments?

@nielsdrost
Copy link
Member

@nielsdrost, could you please let me know when you are done with the figure or just add it to this PR?
I added the figure to this branch. It's a diagrams.net (formally draw.io) image, with the vector image embedded in the png (holy backward metadata batman!)

@axel-lauer
Copy link
Contributor

First of all, nice work! I particularly like the definition of the terms in the glossary. Two comments on the current version:

(1) I think since this document will be part of the user's guide, the wording should be a bit more "determined". E.g. instead of "The goal of this document is to lay out [...]" simply "This document lays out [...]" or instead of "We propose to follow a strategy of timed releases." simply "We aim at following a strategy of timed releases.".

(2) I am still a bit worried that such frequent releases might be to much. Too much in terms of additional work and possibly also confusing for scientist users as there are new versions of the tool "all the time". But I am fine trying to follow the proposed release schedule and see how it goes.

doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
@nielsdrost
Copy link
Member

First of all, nice work! I particularly like the definition of the terms in the glossary. Two comments on the current version:

(1) I think since this document will be part of the user's guide, the wording should be a bit more "determined". E.g. instead of "The goal of this document is to lay out [...]" simply "This document lays out [...]" or instead of "We propose to follow a strategy of timed releases." simply "We aim at following a strategy of timed releases.".

I second that comment, and added some text suggestions to "implement" this.

To strengthen the commitment to the process, we make the text a bit more assertive in places.

Co-authored-by: Niels Drost <n.drost@esciencecenter.nl>
@zklaus
Copy link
Contributor Author

zklaus commented Sep 10, 2020

Thanks @axel-lauer for the suggestions and @nielsdrost for the figure and implementing the suggestion by Axel. I commited them.

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I hope this will increase transparency.

doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
doc/sphinx/source/community/release_strategy.rst Outdated Show resolved Hide resolved
@bouweandela bouweandela merged commit f24bb8a into master Sep 21, 2020
2 checks passed
@bouweandela bouweandela deleted the release-strategy branch September 21, 2020 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants