Skip to content

fix: cleanup structure of editor guide - #385

Open
zenon18 wants to merge 21 commits into
pyOpenSci:mainfrom
zenon18:issue337
Open

zenon18 wants to merge 21 commits into
pyOpenSci:mainfrom
zenon18:issue337

Conversation

@zenon18

@zenon18 zenon18 commented May 18, 2026

Copy link
Copy Markdown

closes #337 The editor's guide is now a section with its details broken up among multiple pages.

Editor Guide -> Position Description & Review Process

  • Position Description (everything upto checklist + closing notes on editorial process)
  • Review Process (rest of the Editor Guide)

Review Process

  • Summed info on finding reviewers and moved any new data to Finding Reviewers
  • Moved the inviting reviewers to Onboarding Reviewers

Finding & Onboarding Editors moved under Editor Guide section

Finding & Onboarding Reviewers -> Finding Reviewers & Onboarding Reviewers

  • Finding Reviewers (everything upto Peer Mentorship)
  • Onboarding Reviewers (Peer Mentorship)

@lwasser

lwasser commented Jun 4, 2026

Copy link
Copy Markdown
Member

@all-contributors please add @zenon18 for docs, review

@allcontributors

Copy link
Copy Markdown
Contributor

@lwasser

I've put up a pull request to add @zenon18! 🎉

@lwasser lwasser changed the title Issue337 fix: cleanup structure of editor guide Jun 4, 2026

@InessaPawson InessaPawson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks so much for taking this on, @zenon18! Splitting the Editor Guide makes it easier to navigate and also makes the overall review process easier to understand.
Could you please rebase this PR? The branch predates the publication fast-track documentation changes on main, so several of the newly split pages currently reintroduce the outdated policy.

Comment thread how-to/review-process.md Outdated
Comment thread how-to/review-process.md Outdated
Comment thread how-to/review-process.md Outdated
Comment thread how-to/onboarding-reviewers.md Outdated
Comment thread how-to/onboarding-reviewers.md Outdated
eliotwrobson and others added 10 commits September 7, 2026 13:54
* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
* Remove merge conflict markers

Leftover merge conflict markers from gen AI update

* Remove duplicate novel method warning

* Fix numbering in package scope for novel methods

* Fix dead links in quote from Adam Sparks
* ci: update docs workflow to Python 3.11

* Apply suggestion from @lwasser

* Pin actions

---------

Co-authored-by: Leah Wasser <leah@pyopensci.org>
…yOpenSci#395)

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
…ture (pyOpenSci#391)

Co-authored-by: Leah Wasser <leah@pyopensci.org>
@zenon18

zenon18 commented Sep 7, 2026

Copy link
Copy Markdown
Author

@InessaPawson I believe I correctly rebased and fixed your suggestions. Let me know if I missed anything. I'm having trouble trying to fix the merge conflict that it has with the no longer existing how-to/editors-guide.md. Open to suggestions on that.

Comment thread how-to/review-process.md Outdated
Comment thread how-to/finding-reviewers.md Outdated
Comment thread how-to/review-process.md Outdated
Comment thread how-to/review-process.md Outdated
Co-authored-by: Inessa Pawson <inessapawson@gmail.com>
Comment thread how-to/review-process.md Outdated
Comment thread how-to/editor-description.md Outdated
Comment thread how-to/editor-description.md Outdated
Co-authored-by: Inessa Pawson <inessapawson@gmail.com>
Comment thread how-to/review-process.md Outdated
Comment thread how-to/onboarding-reviewers.md Outdated
Comment thread how-to/editor-description.md Outdated
Comment thread how-to/editor-description.md Outdated
Comment thread how-to/editor-description.md Outdated
Comment thread how-to/editor-description.md Outdated
Co-authored-by: Inessa Pawson <inessapawson@gmail.com>

@InessaPawson InessaPawson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@zenon18 GitHub's web conflict editor doesn't handle rename/edit conflicts well. Fortunately, git was tracking the rename correctly. I was able to resolve the conflict locally.

Let’s address just one more issue, and the PR will be ready to merge:
how-to/editors-guide.html has been a stable public URL for a long time, and it's linked from open review issues, our onboarding doc, and likely a few Slack posts. This PR updates the one in-repo reference, but external links will start throwing 404 after deploy since we don't currently have a redirect mechanism in conf.py. Please add sphinx-reredirects so the old URL forwards to its successor. I suggest review-process.html as the target since most existing links point at the review workflow.

We are very close. Thank you for your patience through the rebase!

Comment thread how-to/review-process.md Outdated
Comment thread how-to/review-process.md Outdated
@InessaPawson

Copy link
Copy Markdown
Contributor

@shaunagm While reviewing this PR, I noticed several variations of the private Slack channel name for the Editorial Team are used throughout the repo. Could you confirm which one is correct? I’m not in the channel, so I’ll need your help here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: pyconus-2026

Development

Successfully merging this pull request may close these issues.

Duplication of onboarding information in the guide

5 participants