Skip to content

Commit d946a3f

Browse files
authored
Fix: redesign of peer review landing page
2 parents 9cb611e + 8669079 commit d946a3f

File tree

6 files changed

+120
-130
lines changed

6 files changed

+120
-130
lines changed

_includes/package-grid.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
<div class="element-item cards {% for aCategory in apackage.categories %}
2+
<div class="element-item cards bubble {% for aCategory in apackage.categories %}
33
{{ aCategory }}
44
{% endfor %}" data-category="data">
55
<article

_pages/about-peer-review.md

Lines changed: 94 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,133 @@
11
---
22
layout: splash
33
permalink: /about-peer-review/
4-
title: "About the pyOpenSci Open Peer Review Process"
4+
title: "pyOpenSci Reviews Scientific Python Software"
55
header:
66
overlay_image: images/header.jpg
77
overlay_filter: 0.6
88
intro:
9-
- excerpt: "Our open peer review process supports scientists getting credit for the work invested in open Python tools. It also supports standardization of packaging and improved package visibility."
9+
- excerpt: "Our open peer review process facilitates scientists getting credit and recognition for the work they've invested in developing scientific Python tools. The peer review process also supports scientists in finding vetted and maintained software, which drives their open science workflows."
10+
benefits_scientists:
11+
- image_path: images/pyopensci-people-at-computer.jpg
12+
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
13+
excerpt: "Through our [partnerships with domain specific communities](/partners.html) our catalog of trusted tools for scientists across domains continues to grow."
14+
title: "Scientists need trusted and vetted tools to support their open science workflows."
15+
benefits_maintainers:
16+
- image_path: images/pyopensci-people-at-computer.jpg
17+
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
18+
excerpt: "The pyOpenSci peer review process multiplies shared knowledge, making it easier for Pythonistas of all levels to accomplish challenging tasks, such as navigating the Python packaging ecosystem, with relative ease. And our diverse community supports scientific package maintainers in their efforts to develop and build robust software."
19+
title: "pyOS software peer review benefits open source maintainers"
20+
peer_review:
21+
- image_path: images/pyopensci-people-at-computer.jpg
22+
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
23+
excerpt: "Software peer review, similar to the review of scientific papers, is a process where scientists vet software code, documentation and infrastructure. pyOpenSci leads an [open peer review process](https://www.pyopensci.org/software-peer-review/our-process/how-review-works.html) run by a community of dedicated volunteers. Reviews are supportive and fully transparent with the shared goal of improving the quality, usability and maintainability of the software that is driving open science.
24+
25+
* Diverse teams lead each review, enhancing the overall feedback quality."
26+
title: "About peer review of scientific Python software"
27+
- image_path: images/pyopensci-joss-partnership.png
28+
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
29+
excerpt: "Our [partnership with JOSS](https://www.pyopensci.org/software-peer-review/partners/joss.html) means that you don't have to chose between pyOpenSci and JOSS. Simply submit your package to pyOS for review. If your package is accepted and in scope for JOSS, it will be fast-tracked through JOSS' review process. "
30+
title: "Get published with JOSS through a pyOpenSci review"
31+
get-involved:
32+
- image_path:
33+
title: "Become a pyOpenSci reviewer"
34+
alt:
35+
excerpt: "We could use your help! Fill our our reviewer form. We will contact you if we have a package that we need reviewers for. It's OK if you've never reviewed a package before! We'll walk you through it."
36+
url: https://forms.gle/GHfxvmS47nQFDcBM6
37+
btn_label: "> Sign-up Now (Google Form)"
38+
btn_class: btn--inverse
39+
- image_path:
40+
title: "See Our Review Process in Action"
41+
alt:
42+
excerpt: "Our software review process is run using GitHub issues. This means that anyone can check in on any part of any review and read all of the conversation. Check it out."
43+
url: https://github.com/pyOpenSci/software-submission
44+
btn_label: "> See Open Reviews"
45+
btn_class: btn--inverse
46+
- image_path:
47+
title: "Ready to Submit a Package for Review?"
48+
alt:
49+
excerpt: "To submit a package to us, you need to [open an issue in our peer review GitHub repository](https://github.com/pyOpenSci/software-submission/issues/new/choose). Learn about the steps to submit a package for open peer review in our guidebook."
50+
url: https://www.pyopensci.org/python-package-guide/
51+
btn_label: "> View our Author Guide"
52+
btn_class: btn--inverse
1053
toc: false
11-
classes:
54+
classes: flowing
1255
---
1356

57+
1458
{% include feature_row id="intro" type="center" %}
1559

16-
<!--TODO: this into a template -->
1760

18-
<div class="feature__wrapper">
19-
<div class="feature__item ">
20-
<div class="archive__item cards">
21-
<div class="archive__item-body">
22-
<h2 class="archive__item-title">Ready to Submit a Package for Review?</h2>
23-
<div class="archive__item-excerpt">
24-
<p>You're in the right place! Learn about the steps to submit a package
25-
for open peer review in our guidebook. </p>
26-
</div>
27-
<p><a href="https://www.pyopensci.org/software-peer-review/how-to/author-guide.html" class="btn btn--inverse"><i class="fas fa-angle-right"></i> View our Author Guide </a></p>
28-
</div>
29-
</div>
30-
</div>
31-
32-
<div class="feature__item">
33-
<div class="archive__item cards">
34-
<div class="archive__item-body">
35-
<h2 class="archive__item-title">Want to Review a Python Package for Us?</h2>
36-
<div class="archive__item-excerpt">
37-
<p>We could use your help! Fill our our reviewer form. We will
38-
contact you if we have a package that we need reviewers for.
39-
It's OK if you've never reviewed a package before! We'll walk you
40-
through it. </p>
41-
</div>
42-
<p><a href="https://forms.gle/GHfxvmS47nQFDcBM6" class="btn btn--inverse"><i class="fas fa-angle-right"></i>
43-
Signup Now (Google Form) </a></p>
44-
</div>
45-
</div>
46-
</div>
47-
48-
<div class="feature__item">
49-
<div class="archive__item cards">
50-
<div class="archive__item-body">
51-
<h2 class="archive__item-title">See Our Review Process in Action</h2>
52-
<div class="archive__item-excerpt">
53-
<p>Our reviewers happen in GitHub issues. This means that anyone can
54-
check in on any part of any review and read all of the conversation.
55-
Check it out.</p>
56-
</div>
57-
<p><a href="https://github.com/pyOpenSci/software-review/issues" class="btn btn--inverse"><i class="fas fa-angle-right"></i> See Open Reviews </a></p>
58-
</div>
59-
</div>
60-
</div>
61-
</div>
61+
<div class="pyos-section purple">
62+
<div class="content" markdown="1">
6263

63-
## Our editorial board
64+
{% include feature_row id="peer_review" type="left" %}
6465

65-
{: .clearall }
66+
</div>
67+
</div>
6668

67-
We value our volunteer editors. Learn more about what editors do and how we
68-
select them here.
69+
{% include div_purple_bottom.html %}
6970

70-
{% assign editors = site.data.contributors | where: 'editorial_board', true %}
71-
{% assign editors = editors | sort: 'sort' %}
7271

72+
<div class="pyos-section" markdown="1">
73+
<div class="content" markdown="1">
7374

74-
<div class="grid">
75-
{% for aperson in editors %}
76-
{% unless aperson.board %}
77-
{% include people-grid.html %}
78-
{% endunless %}
79-
{% endfor %}
80-
</div>
75+
{% include feature_row id="benefits_scientists" type="right" %}
76+
{% include feature_row id="benefits_maintainers" type="right" %}
8177

82-
<br clear="both">
83-
84-
<div class="wide__p_text" markdown="1">
8578

86-
## Why Peer Review for Python Scientific Software?
87-
88-
Peer review of Python scientific software addresses several challenges in the
89-
open source community:
79+
</div>
80+
</div>
9081

91-
1. **Citations Support Credit & Acknowledgement:** Peer review provides credit and acknowledgement for the hard work invested in creating and supporting core tools that support open science workflows.
92-
2. **Standard Packaging & Documentation:** Currently there are numerous ways to create a Python package. Peer review enforces standards thus promoting standardization of Python packaging across the scientific Python ecosystem.
93-
3. **Removed Redundancy:** Peer review addresses the issue of multiple tools on pyPi that perform similar tasks but have varying levels of documentation, support and maintenance. One maintained package that is broadly useful and maintained will help scientists select tools that they can rely on.
94-
4. **Long Term Maintenance:** Package maintainers often use their free time to work on Python tools. Once a package is reviewed by pyOpenSci we will keep in touch with the maintainer to ensure continued maintenance of the tool. If a maintainer needs to step down, we will try to find someone new to take over, or sunset the tool as needed.
95-
5. **Community:** At the core of peer review is community around the tools that scientists need to process their data.
82+
<!-- {% include div_purple_top.html %} -->
9683

97-
### Who can submit a package?
84+
<div class="pyos-section purple">
85+
<div class="content" markdown="1">
9886

99-
pyOpenSci packages are community developed, submitted and reviewed. Anyone is
100-
welcome to submit a package to pyOpenSci to be reviewed. Once the package is reviewed,
101-
and accepted, pyOpenSci will promote it as a peer-reviewed tool for science!
87+
## Get involved with peer review
10288

103-
### How do I decide whether to submit to you or the Journal of Open Source Software (JOSS)
89+
{% include feature_row_pyos id="get-involved" %}
10490

105-
You don't have to chose between pyOpenSci and JOSS. We have a collaboration with
106-
JOSS where you can submit your package to us for review. If your package is accepted
107-
and if it is in scope for JOSS, it will then be fast tracked through their
108-
review process; they will only review your paper.md file. Consider this a
109-
win-win!
11091

92+
</div>
11193
</div>
11294

113-
<!--
114-
<div class="notice" markdown="1">
115-
## What's the difference between pyOpenSci and JOSS?
95+
{% include div_purple_bottom.html %}
96+
{: .clearall }
11697

117-
> You don't have to chose between pyOpenSci and JOSS; You can submit your package to both.
98+
<div class="content noimage" markdown="1">
11899

119-
pyOpenSci and [the Journal of Open Source Software (JOSS)](https://joss.theoj.org/)
120-
are complementary, partner organizations; and you don't have to chose one or the
121-
other! After a package to pyOpenSci has been reviewed and accepted by pyOpenSci
122-
you can chose to also register it with JOSS. JOSS has [more limited scope](https://joss.readthedocs.io/en/latest/review_criteria.html) of the
123-
for packages that it will review. For instance while pyOpenSci will review and
124-
accept API wrappers, JOSS won't.
100+
## Meet our editorial board
125101

126-
If your package is accepted by pyOpenSci and in scope for JOSS, JOSS will fast
127-
track your package through their process given it was already reviewed by us.
128-
Once accepted by JOSS, you now have both a pyOpenSci acceptance and one by JOSS.
129-
Joss will then give you a cross-ref supported DOI for citation.
102+
The pyOpenSci software peer review process is led by a volunteer team of
103+
editors from the scientific Python community. Editors do the following things:
130104

131-
### Why Two Review Processes JOSS and pyOpenSci?
105+
* They find reviewers from diverse backgrounds who have a mixture of scientific domain and Python experience.
106+
* They oversee the entire review process for a package ensuring it runs in a timely and efficient manner
107+
* They support the submitting authors and reviewers in answering questions related to the review
108+
* They determine whether that package should be accepted into the pyOpenSci ecosystem once the review has wrapped up.
132109

133-
the pyOpenSci review process is different from that of JOSS in a few ways:
134-
* pyOpenSci is specific to the Python community and thus will enforce community specific python specific standards.
135-
* pyOpenSci places heavy emphasis on documentation and usability in our reviews and associated standardization of both.
136-
* pyOpenSci builds community around and visibility for it's tools.
137-
* pyOpenSci supports long term tool maintenance.
110+
Learn more about the
111+
editor role at pyOpenSci [in our peer review guide.](https://www.pyopensci.org/software-peer-review/how-to/editors-guide.html)
138112

113+
{% assign editors = site.data.contributors | where: 'editorial_board', true %}
114+
{% assign editors = editors | sort: 'sort' %}
139115

140-
JOSS reviews are [more limited in scope](https://joss.readthedocs.io/en/latest/review_criteria.html) compared to pyOpenSci and the
141-
[submission criteria](https://joss.readthedocs.io/en/latest/review_criteria.html)
142-
are, in places, less stringent than those of pyOpenSci.
116+
<div class="grid clean">
117+
{% for aperson in editors %}
118+
{% unless aperson.board %}
119+
{% include people-grid.html %}
120+
{% endunless %}
121+
{% endfor %}
143122
</div>
144123

124+
<br clear="both">
125+
</div>
145126

146127

147-
-->
148-
149-
## Recently Accepted Python Packages
128+
<div class="content">
129+
<div class="feature__wrapper">
130+
<h2> Recently Accepted scientific Python Packages</h2>
150131

151132
{% assign packages_sorted = site.data.packages | sort_natural: 'date_accepted' | reverse %}
152133

@@ -159,3 +140,7 @@ are, in places, less stringent than those of pyOpenSci.
159140
<br clear="both">
160141

161142
<a href="/python-packages/" class="btn btn--info">View All Accepted Packages <i class="fa fa-4 fa-arrow-circle-right" aria-hidden="true"></i></a>
143+
144+
</div>
145+
146+
</div>

_sass/minimal-mistakes/_archive.scss

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,8 +240,8 @@
240240

241241
.feature__wrapper {
242242
@include clearfix();
243-
margin-bottom: 2em;
244-
border-bottom: 1px solid $border-color;
243+
margin-bottom: .02em; //used to be 2em
244+
// border-bottom: 1px solid $border-color;
245245

246246
.archive__item-title {
247247
margin-bottom: 0;

_sass/minimal-mistakes/_pyos-flowing-page.scss

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.pyos-section {
2-
padding: 20px;
2+
padding: 0px;
33
&.purple {
44
background-color: #e2dfed; //d9d5e8; #cbc6e0;
55
position: relative;
@@ -40,4 +40,8 @@ svg.bottom {
4040
max-width: 1280px;
4141
margin-right: auto;
4242
margin-left: auto;
43+
44+
&.noimage {
45+
max-width: 900px;
46+
}
4347
}

_sass/minimal-mistakes/_pyos-grid.scss

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
/* Create & style a 3x3 grid wrapper */
44
.grid {
55
display: grid;
6-
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
6+
// minmax can be used to modify width
7+
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
78
grid-gap: 10px;
89

910
h4.grid_title {
@@ -78,15 +79,29 @@
7879
font-size: 1.1em!important;
7980
}
8081

82+
.bubble:before {
83+
content: "";
84+
position: absolute;
85+
z-index: -1;
86+
top: -16px;
87+
right: -16px;
88+
background: #967eb6;
89+
height: 32px;
90+
width: 32px;
91+
border-radius: 32px;
92+
transform: scale(2);
93+
transform-origin: 50% 50%;
94+
transition: transform 0.15s ease-out;
95+
}
96+
8197
.cards {
8298
display: block;
8399
top: 0px;
84100
position: relative;
85101
max-width: 362px;
86102
background-color: #f1f0f1;;
87103
border-radius: 4px;
88-
padding: 32px 24px;
89-
margin: 12px;
104+
// padding: 32px 24px;
90105
text-decoration: none;
91106
z-index: 0;
92107
overflow: hidden;
@@ -135,20 +150,6 @@
135150
cursor: pointer;
136151
}
137152

138-
&:before {
139-
content: "";
140-
position: absolute;
141-
z-index: -1;
142-
top: -16px;
143-
right: -16px;
144-
background: #967eb6;
145-
height: 32px;
146-
width: 32px;
147-
border-radius: 32px;
148-
transform: scale(2);
149-
transform-origin: 50% 50%;
150-
transition: transform 0.15s ease-out;
151-
}
152153

153154
&:hover:before {
154155
transform: scale(2.15);

images/pyopensci-joss-partnership.png

131 KB
Loading

0 commit comments

Comments
 (0)