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

Fix: add favicon and add blocks to author guide #263

Merged
merged 4 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@

# Theme options
Copy link
Member Author

Choose a reason for hiding this comment

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

this adds the pyos favicon ✨

html_theme_options = {
"favicons": [
{
"rel": "icon",
"sizes": "16x16",
"href": "https://www.pyopensci.org/images/favicon.ico",
},
],
"announcement": "<p><a href='https://www.github.com/pyopensci/software-submission/'>Submit Your Python Package for Peer Review!</a></p>",
"external_links": [
{
Expand Down
74 changes: 72 additions & 2 deletions how-to/author-guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Guide for Python Open Source Maintainers and Authors
# Peer Review Guide for Python Open Source Authors / Authors

```{toctree}
:hidden:
Expand All @@ -22,7 +22,77 @@ Finding Reviewers <finding-reviewers>

Are you considering submitting a package for review with pyOpenSci? You've
come to the right place! Below you will find the steps that you need to follow
to submit a package to pyOpenSci for peer review.
to submit a package to pyOpenSci for peer review along with some additional resources that you may find useful.

## Peer review resources

::::{grid} 1 2 3 3
:class-container: text-center
:gutter: 3

:::{grid-item-card} <i class="fa-solid fa-crosshairs"></i> Package scope
:link: ../about/package-scope
:link-type: doc
:class-header: bg-light

Learn about the requirements and scope of packages that pyOpenSci reviews.
+++
<i class="fa-solid fa-link"></i> Learn more
:::

:::{grid-item-card} <i class="fa-solid fa-magnifying-glass"></i> How review works
:link: ../our-process/how-review-works
:link-type: doc
:class-header: bg-light

We review packages openly using GitHub Issues.
+++
<i class="fa-solid fa-link"></i> Learn more
:::

:::{grid-item-card} <i class="fa-solid fa-timeline"></i> Review timeline
:link: ../our-process/review-timeline
:link-type: doc
:class-header: bg-light

Curious about the general timeline for pyOpenSci reviews?
+++
<i class="fa-solid fa-link"></i> Learn more here
:::


:::{grid-item-card} Review Guidelines & Policies
:link: ../our-process/policies
:link-type: doc
:class-header: bg-light

Read about our peer review policies.
+++
<i class="fa-solid fa-link"></i> Learn more
:::


:::{grid-item-card} <i class="fa-solid fa-handshake-angle"></i></i> Need packaging guidance?
:link: https://www.pyopensci.org/python-package-guide/
:link-type: doc
:class-header: bg-light

If you want to learn more about packaging best practices, you can check out our packaging guide.
+++
<i class="fa-solid fa-arrow-up-right-from-square"></i> Go there now
:::

:::{grid-item-card} <i class="fa-solid fa-clipboard-question"></i> Questions?
:link: https://pyopensci.discourse.group/c/review-process/7
:link-type: doc
:class-header: bg-light

If you have questions about our process or packaging in general, please ask them on our discourse! We are here to help you.
+++
<i class="fa-solid fa-arrow-up-right-from-square"></i> Go there now
:::
::::


Before you begin this process, [please be sure to read the review process guidelines](../our-process/policies).

Expand Down
2 changes: 1 addition & 1 deletion how-to/editors-guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# pyOpenSci Guide for Peer Review Editors
# pyOpenSci Software Review Editor Guide

<!--
```{note}
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Learn about the scope of the packages that we review.
[Click to learn more »](about/package-scope)
:::

:::{grid-item-card} {octicon}`code-square;1.5em;sd-mr-1`Maintainers Guide
:::{grid-item-card} {octicon}`code-square;1.5em;sd-mr-1`Authors Guide
:link: how-to/author-guide
:link-type: doc
:class-header: bg-light
Expand Down
Loading