Skip to content

Commit 0da8f88

Browse files
authored
Add: github section to our handbook (#57)
* Add: github section to our handbook * Fix: move pr info to another page * Finesse language * Update community/github/our-repositories.md * Update community/index.md
1 parent e910d3b commit 0da8f88

File tree

4 files changed

+82
-2
lines changed

4 files changed

+82
-2
lines changed

community/github.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

community/github/intro.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# GitHub
2+
3+
:::{todo}
4+
1. for extra contributors - A pyOpenSci community member will review your post / contribution. you don't need to request a review.
5+
1.
6+
:::
7+
8+
9+
pyOpenSci has a suite of GitHub repositories (repos) that support pyOpenSci processes and content including:
10+
11+
* website content
12+
* tools that track contributors and keep the website up to date
13+
* peer review

community/github/our-repositories.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Our Repositories
2+
3+
:::{todo}
4+
Add repositories from the pyOpenSci organization.
5+
:::
6+
7+
## pyOpenSci GitHub Repository Overview
8+
9+
pyOpenSci manages multiple GitHub repositories to support various community
10+
activities. Below is a description of each core repository.
11+
12+
### [Software-review Repository](https://www.pyopensci.org/software-peer-review/)
13+
14+
The software-review repository is where community package submissions are
15+
peer-reviewed. All submissions are made through GitHub Issues. [Learn more about
16+
our peer review process here.](https://www.pyopensci.org/software-peer-review/)
17+
18+
:::{important}
19+
Important: If a pyOpenSci core member identifies an issue with the review
20+
submission template, consult both the editorial team and core team before making
21+
any changes. This template's data are processed by a Python workflow, and even
22+
small modifications could disrupt the language processing.
23+
:::
24+
25+
26+
### Software-peer-review Guidebook Repository
27+
28+
This repository hosts our [software peer review guide](https://www.pyopensci.org/software-peer-review/),
29+
which includes instructions and guidelines for authors, editors, the editor in
30+
chief, and the peer review triage team. It also details our peer review policies,
31+
partnerships, and the templates used in the review process.
32+
33+
### Python-package-guide Repository
34+
35+
The [python-package-guide repository](https://www.pyopensci.org/python-package-guide/)
36+
contains our community-developed guidelines and tutorials on Python packaging.
37+
These resources are beginner-friendly and reflect best practices.
38+
39+
### [pyosMeta Repository](https://github.com/pyOpenSci/pyosMeta)
40+
41+
The pyosMeta repo contains a Python package published on PyPI that tracks our
42+
package review and contributor data. This data is used in a GitHub action to
43+
update our website.
44+
45+
### [pyopensci.github.io Repository](https://github.com/pyOpenSci/pyopensci.github.io)
46+
47+
Our website, [pyOpenSci](https://www.pyopensci.org/), is hosted on GitHub and
48+
uses the Jekyll Minimal Mistakes theme. The python packages page, contributor page and peer review team page are all updated automagically using a
49+
GitHub action workflow that is supported by the pyosMeta Python package. The workflow runs every other week but can be triggered manually as a **workflow
50+
dispatch**.
51+
52+
1. **Packages.yml**: Updates the [Python Packages page](https://www.pyopensci.org/python-packages.html)
53+
by parsing reviews from software-review repository issues.
54+
2. **Contributors.yml**: Updates the [Our Community page](https://www.pyopensci.org/our-community/index.html)
55+
by parsing data from all organization repositories.
56+
57+
:::{todo}
58+
Update the website contributors guide with general CI and specific Jekyll
59+
information.
60+
:::
61+
62+
## [Handbook Repository](https://github.com/pyOpenSci/handbook)
63+
64+
The handbook repository hosts content that helps the community navigate our
65+
online resources and communication channels.

community/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33

44
:::{toctree}
5+
:hidden:
56
:caption: Social Media Section
67

78
Social Media <social>
@@ -10,7 +11,9 @@ Slack <slack>
1011

1112

1213
:::{toctree}
14+
:hidden:
1315
:caption: GitHub Section
1416

15-
GitHub <github>
17+
GitHub <github/intro>
18+
Our Repos <github/our-repositories>
1619
:::

0 commit comments

Comments
 (0)