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 edit via github method to Iris docs #4461

Merged
merged 8 commits into from
Jan 6, 2022

Conversation

wjbenfold
Copy link
Contributor

🚀 Pull Request

Description

Split the "contributing documentation" page to give two options - the previous method that relies on developer knowledge and the method that uses Github's editing abilities. Added directions to the previous landing page that point people to the right one.


Consult Iris pull request check list

@wjbenfold wjbenfold force-pushed the wjbenfold-doc-edit-how-to branch from 31ee315 to 75b40d5 Compare December 14, 2021 15:41
@bjlittle bjlittle self-assigned this Jan 5, 2022
@bjlittle
Copy link
Member

bjlittle commented Jan 5, 2022

@wjbenfold Sadly this has gone slightly stale... fancy rebasing to resolve your conflict?

@wjbenfold wjbenfold force-pushed the wjbenfold-doc-edit-how-to branch from a488e4c to feb89e9 Compare January 5, 2022 10:22
Copy link
Member

@bjlittle bjlittle left a comment

Choose a reason for hiding this comment

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

@wjbenfold This is a step change in clarity. Congrats! 🥳

Communicating clearly and succinctly is not easy, so I really appreciate the effort that you've put into this @wjbenfold and @alastair-gemmell

Just a few minor review suggestions to address and then we can bank this documentation goodness 👍

@bjlittle bjlittle merged commit 925998e into SciTools:main Jan 6, 2022
@wjbenfold wjbenfold deleted the wjbenfold-doc-edit-how-to branch January 6, 2022 12:26
tkknight added a commit to tkknight/iris that referenced this pull request Jan 6, 2022
* main:
  Use partial to make cube pickleable (SciTools#4377)
  Add edit via github method to Iris docs (SciTools#4461)
  Broken cartopy links in docs (SciTools#4464)
  rtd with latest mambaforge image for faster building (SciTools#4476)
  Show acceptable image test results in the docs (SciTools#4392)
  Nc load latlon fix (SciTools#4470)
  update matplotlib links (SciTools#4474)
  Whatsnew for PR 4462 (SciTools#4475)
  Clarify the return type of iris.load (AVD-1899) (SciTools#4462)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4472)
  Updated environment lockfiles (SciTools#4467)
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.

3 participants