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.

Sign up for GitHub

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

Jump to bottom

Developer guide overhaul #3852

Merged
merged 12 commits into from
Sep 18, 2020
Merged

Developer guide overhaul #3852

merged 12 commits into from
Sep 18, 2020

Conversation

tkknight
Copy link
Contributor

@tkknight tkknight commented Sep 15, 2020 •
edited
Loading

🚀 Pull Request

Description

Overhaul of the Developers Guide section in the documentation. Notable changes include:

  • New sections:
    • Continuous Integration (CI) Testing
    • Getting Involved
    • Running the tests
  • Updated sections:
    • Contributing (github convention) now points to the docs
    • Code Formatting
    • Graphics tests
    • Pull request check list
    • Reworking of the existing git guide (gitwash)
    • Excluded some git urls from the linkcheck to avoid hitting the domain too many times and being blocked
    • PR template (points to new PR checklist)
  • Various spelling and layout updates

For the lifetime of this PR you can view the rendered html here:

If you wish to read the changes as rendered, I suggest starting from the Getting Involved section and hitting Next to review the entire Developers Guide section:

  1. What's new entry primed in a separate PR: Added whats new entry for pr3852 #3854

Consult Iris pull request check list

@tkknight
developer guide overhaul baseline
d0cf5f2
@tkknight
added todo
9655aab
@tkknight
added todos
4d01da0
@tkknight
Addressed all todos.
bbc9137
@tkknight
Merge branch 'master' into developer_guide_overhaul
7f1e58f 
* master:
  whatsnew - using the author github id (SciTools#3849)
  Bring SciTools#3804 whatsnew in line with format changes from SciTools#3838. (SciTools#3847)
  "What's New" credit and referencing (SciTools#3838)
  Allow passing None for all coord-system optional args. (SciTools#3804)
  var_name in AuxCoord created by trajectory.interpolate() (SciTools#3718)
@tkknight
Updated PR template
5f1a0c8
@tkknight
Corrected spelling
7138ca4
@tkknight
Used ref intead of a relative url.
908ba1c
@bjlittle bjlittle added this to the v3.0.0 milestone Sep 15, 2020
@tkknight tkknight mentioned this pull request Sep 15, 2020
Merged
@tkknight tkknight marked this pull request as ready for review September 15, 2020 21:09
rcomer
rcomer reviewed Sep 16, 2020
View reviewed changes
Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

Hi @tkknight, thanks for doing this. It's a massive improvement! I don't think I've looked at everything, but just have some comments aimed at making it a bit more idiot-proof.

docs/iris/src/developers_guide/contributing_pull_request_checklist.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_pull_request_checklist.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_running_tests.rst Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_code_formatting.rst Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_documentation.rst Show resolved Hide resolved
@tkknight
Copy link
Contributor Author

Hi @rcomer. I have addressed all your suggestions, the updated docs should be present in a few minutes (see it building: https://readthedocs.org/projects/iris-test-doc/builds/11893698/)

@rcomer
Copy link
Member

rcomer commented Sep 16, 2020

Thanks @tkknight, all the changes look good to me. Think this still needs a review from somebody who understands all the technical ins and outs. In that context, I'm a nobody!

trexfeathers
trexfeathers requested changes Sep 17, 2020
View reviewed changes
Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

First of all, @tkknight and @bjlittle I just want to say what a excellent job you've done here 😍

I'm sure I'm not the only one who has in the past been cautioned against following the existing guide, for fear of it being outdated. But now I can see all the necessary knowledge - which many of us have learned in patches, with some difficulty - all combined into a single easy to follow guide - brilliant!

I've found a few minor points of grammar and readability that could be improved. Since @tkknight is enjoying some well earned time off I'm sure I can find someone else on the release team to push changes to this branch.

docs/iris/src/developers_guide/contributing_documentation.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_code_formatting.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/documenting/docstrings.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/documenting/rest_guide.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_graphics_tests.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_graphics_tests.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_ci_tests.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_ci_tests.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_ci_tests.rst Outdated Show resolved Hide resolved
docs/iris/src/developers_guide/contributing_ci_tests.rst Outdated Show resolved Hide resolved
@bjlittle
Copy link
Member

@trexfeathers Thanks for the pair review to see this over the line... over to you now.

@trexfeathers
Copy link
Contributor

🎉🎉

@trexfeathers trexfeathers merged commit 65c6144 into SciTools:master Sep 18, 2020
@rcomer
Copy link
Member

rcomer commented Sep 18, 2020

Awesome work y'all!

@tkknight tkknight linked an issue Sep 18, 2020 that may be closed by this pull request
[PI] Developer Guide Overhaul #3824
Closed
5 tasks
This was referenced Sep 18, 2020
Closed
Closed
Closed
tkknight added a commit to tkknight/iris that referenced this pull request Sep 20, 2020
@tkknight
Merge branch 'master' into whats_new_for_pr3852
acd5c18 
* master:
  Whatsnew for effects on aux factories of units defaulting to 'unknown'. (SciTools#3870)
  Whatsnew entry for SciTools#3867. (SciTools#3868)
  Developer guide overhaul (SciTools#3852)
  Update CF standard name table to v75 (SciTools#3867)
  Link to new classes and methods in the Ancillary variables whatsnew. (SciTools#3865)
  update black version (SciTools#3866)
  Fix whatsnew api links. (SciTools#3856)
  Add additional pre-commit hooks (SciTools#3862)
  update pre-commit flake8 version (SciTools#3863)
  whatsnew - update announcement (SciTools#3861)
  whatsnew - remove contents directive (SciTools#3859)
  whatsnew - links and versions (SciTools#3853)
  Replace deprecated IndexFormatter (SciTools#3857)
  whatsnew for SciTools#3681 (SciTools#3858)
  Whatsnew entry for SciTools#3846. (SciTools#3855)
  Image tests: set agg backend after rcdefaults (SciTools#3846)
  whatnew - announcements (SciTools#3850)
@tkknight tkknight deleted the developer_guide_overhaul branch September 22, 2020 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rcomer rcomer rcomer left review comments

@trexfeathers trexfeathers trexfeathers approved these changes

Assignees
No one assigned
Labels
Type: Documentation Type: Enhancement
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.

[PI] Developer Guide Overhaul
4 participants
@tkknight @rcomer @bjlittle @trexfeathers