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

Improve documentation of the review process #117

Merged
merged 127 commits into from
Mar 7, 2023
Merged

Conversation

acocac
Copy link
Member

@acocac acocac commented Aug 30, 2022

Before review

  • Work in progress
  • Ready for review
  • Need help!

Description

The PR aims to improve guidelines and details of the submission and reviewing process. It also make some general changes for improving the user experience of the notebook as follows:

  • Refactor Table of Content, with shorter and self-descriptive titles in the left panel.
  • Add new chapter for publishing
    • About
    • Guidelines
      • Authors
      • Reviewers
      • Editors
      • Editors-in-chief
      • Community
  • Rename EnvDS book to EDS book.
  • Remove unused sections:
    • digital twins (never published)
    • statistics (afterword)
    • glossary (afterword)

Motivation and Context

Fixes #115

How has this been tested?

No major changes. Local run in MacOS to build the plain markdowns.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • New notebook and/or content
  • Documentation notebook/content update
  • Other (please describe):
  • Feature change (upgrade version)

Checklist:

  • My code follows the code style of this project: Python
  • I have read the CONTRIBUTING doc
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests to cover my changes
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage)

Additional information

@acocac acocac added documentation Improvements or additions to documentation update labels Aug 30, 2022
@acocac acocac self-assigned this Aug 30, 2022
@netlify
Copy link

netlify bot commented Aug 30, 2022

Deploy Preview for the-environmental-ds-book ready!

Name Link
🔨 Latest commit ecb175e
🔍 Latest deploy log https://app.netlify.com/sites/the-environmental-ds-book/deploys/640677d59110680008c9c1cc
😎 Deploy Preview https://deploy-preview-117--the-environmental-ds-book.netlify.app/publishing/about/aims-and-scope
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@acocac acocac marked this pull request as ready for review August 30, 2022 20:29
@acocac acocac changed the title add review process with illustrations Improve documentation of the review process Aug 30, 2022
@acocac acocac added this to In progress in Roadmap Sep 16, 2022
@acocac
Copy link
Member Author

acocac commented Mar 2, 2023

@EstherPlomp thanks for your great inputs and feedback of the Open Peer Review guidelines for EDS book notebooks. I've addressed all your comments, please let me know if you have any additional observations. The optimal timings for publication when notebook starts the REVIEW stage are 2 weeks review, 2 weeks changes, 1 week reviewers approval. These timings are based on PyOpenSci.

@acocac acocac requested a review from EstherPlomp March 2, 2023 15:19
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@acocac acocac requested review from annefou and EstherPlomp and removed request for EstherPlomp March 6, 2023 23:33
@acocac
Copy link
Member Author

acocac commented Mar 6, 2023

@annefou thanks for contributing to the proposed guidelines and sections covered in this PR. I went through your comments and addressed most of them. Everything is ready for you to review it again.

@acocac acocac mentioned this pull request Mar 7, 2023
21 tasks
Copy link
Collaborator

@annefou annefou left a comment

Choose a reason for hiding this comment

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

Really nice guidelines; much more comprehensive and clearer. Thanks a lot!

@acocac
Copy link
Member Author

acocac commented Mar 7, 2023

Thanks everyone for your contribution I'll merge it in preparation to #126.

@acocac acocac merged commit c0227ab into master Mar 7, 2023
@acocac acocac added this to the web-interface milestone Apr 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation update
Projects
Roadmap
In progress
Development

Successfully merging this pull request may close these issues.

[ENH] Improve submission/reviewing guidelines
3 participants