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

whatsnew overhaul #3769

Merged
merged 6 commits into from
Aug 4, 2020
Merged

whatsnew overhaul #3769

merged 6 commits into from
Aug 4, 2020

Conversation

tkknight
Copy link
Contributor

@tkknight tkknight commented Aug 3, 2020

Build

  • Removed aggregate_directory.py, and calls to it from .travis.yml
  • All unreleased changes can now go directly into latest.rst
  • The what's new latest.rst is always built unless a release is made (manual steps, documentation updated)
  • The last 2 warnings in the documentation build are now resolved - clean build!

Documentation

  • Updated the whats_new_contributions.rst to show the new process
  • Update the whatsnew categories (replaced "dependencies" with "internal" so it is more generic)
  • Added "Maintainer steps" to the release.rst
  • What's new files layout and titles updated to be more useful. 80 char width also applied for readability
  • Added a latest.rst.template for easy base lining of a new latest.rst

Misc

  • Add html-noplot to the top level Makefile (already in the level below)
  • When built on the ReadTheDocs server, all the environment variables will be printed for reference

You can view the build documentation on a test Read The Docs page: https://iris-test-doc.readthedocs.io/en/latest/, specifically:

The PR may close #2104 and #3451.

@tkknight tkknight linked an issue Aug 3, 2020 that may be closed by this pull request
@tkknight tkknight marked this pull request as ready for review August 3, 2020 11:51
If created, the pre-release shall be available for at least one week prior to the release being cut. User groups should be notified of the existence of the pre-release and encouraged to test the functionality.
If created, the pre-release shall be available for at least one week prior to
the release being cut. User groups should be notified of the existence of the
pre-release and encouraged to test the functionality.
Copy link
Member

@bjlittle bjlittle Aug 3, 2020

Choose a reason for hiding this comment

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

@tkknight At a minimum we'd announce this on our scitools-iris twitter feed, don't know if you want to mention that here?.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this could be added - but this step would need to be added to the maintainer steps too.

@bjlittle bjlittle self-assigned this Aug 3, 2020
Copy link
Member

@pp-mo pp-mo left a comment

Choose a reason for hiding this comment

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

This is clearly a huge improvement !
I've hit a few typos + ideas, mostly explicit suggested changes.

I really like the release account, and the step-by-step. The account there is much clearer for using a specific example version number.

I'm still not sure we've covered how the process is slightly different for point releases and release candidates, regarding the uses of tags, version strings and documentation builds.
But, I'd like to tackle that separately as this is complicated enough + I'm not sure of my facts right now.

@tkknight tkknight linked an issue Aug 4, 2020 that may be closed by this pull request
5 tasks
@pp-mo pp-mo merged commit 3bb0403 into SciTools:master Aug 4, 2020
tkknight added a commit to tkknight/iris that referenced this pull request Aug 14, 2020
* master:
  remove duplicate whats new entries from the last release (SciTools#3773)
  whatsnew latest update (SciTools#3771)
  whatsnew overhaul (SciTools#3769)
  Gallery code consistency (SciTools#3766)
  enabled pdf creation (SciTools#3765)
tkknight added a commit to tkknight/iris that referenced this pull request Aug 15, 2020
* master:
  remove duplicate whats new entries from the last release (SciTools#3773)
  whatsnew latest update (SciTools#3771)
  whatsnew overhaul (SciTools#3769)
  Gallery code consistency (SciTools#3766)
  enabled pdf creation (SciTools#3765)
  pin matplotlib<3.3 (SciTools#3763)
  moved to oceanography section of gallery (SciTools#3761)
  unpin cftime (SciTools#3757)
  flake8 outstanding files (SciTools#3755)
  Numpy rounding fix (SciTools#3758)
owena11 pushed a commit to owena11/iris that referenced this pull request Aug 19, 2020
* whatsnew overhaul

* corrected link

* various corrections

* typo fix

* Update docs/iris/src/developers_guide/documenting/whats_new_contributions.rst

Co-authored-by: Patrick Peglar <[email protected]>

* Âwording improvements

Co-authored-by: Patrick Peglar <[email protected]>
@tkknight tkknight deleted the whatsnew_overhaul branch September 10, 2020 13:57
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.

What's New Compilation Procedure/Automation Making compiling the "What's new" easier
3 participants