Skip to content

Add edit via github method to Iris docs - #4461

Merged
bjlittle merged 8 commits into
SciTools:mainfrom
wjbenfold:wjbenfold-doc-edit-how-to
Jan 6, 2022
Merged

Add edit via github method to Iris docs#4461
bjlittle merged 8 commits into
SciTools:mainfrom
wjbenfold:wjbenfold-doc-edit-how-to

Conversation

@wjbenfold

@wjbenfoldwjbenfold commented Dec 14, 2021

Copy link
Copy Markdown
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
wjbenfoldforce-pushed the wjbenfold-doc-edit-how-to branch from 31ee315 to 75b40d5CompareDecember 14, 2021 15:41
@bjlittlebjlittle self-assigned this Jan 5, 2022
@bjlittle

bjlittle commented Jan 5, 2022

Copy link
Copy Markdown
Member

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

@wjbenfold
wjbenfoldforce-pushed the wjbenfold-doc-edit-how-to branch from a488e4c to feb89e9CompareJanuary 5, 2022 10:22
bjlittle
bjlittle requested changes Jan 5, 2022
View reviewed changes

@bjlittlebjlittle left a comment •
edited
Loading

Copy link
Copy Markdown
Member

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 👍

Comment threaddocs/src/developers_guide/contributing_documentation.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst
Comment threaddocs/src/developers_guide/contributing_documentation_easy.rst Outdated
wjbenfold
wjbenfold commented Jan 6, 2022
View reviewed changes
Comment threaddocs/src/developers_guide/contributing_documentation.rst Outdated
bjlittle
bjlittle reviewed Jan 6, 2022
View reviewed changes
Comment threaddocs/src/whatsnew/latest.rst Outdated
@bjlittle
bjlittle merged commit 925998e into SciTools:mainJan 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
@tkknight
Merge branch 'main' into votable_issues
6a4ab8c
* 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bjlittlebjlittlebjlittle approved these changes

Assignees

@bjlittlebjlittle

Labels

Type: Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@wjbenfold@bjlittle@rcomer