From 0da8f882e00c4adf2df722866372395b7b5d6342 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Thu, 18 Apr 2024 16:36:40 -0600 Subject: [PATCH] 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 --- community/github.md | 1 - community/github/intro.md | 13 ++++++ community/github/our-repositories.md | 65 ++++++++++++++++++++++++++++ community/index.md | 5 ++- 4 files changed, 82 insertions(+), 2 deletions(-) delete mode 100644 community/github.md create mode 100644 community/github/intro.md create mode 100644 community/github/our-repositories.md diff --git a/community/github.md b/community/github.md deleted file mode 100644 index c27f953..0000000 --- a/community/github.md +++ /dev/null @@ -1 +0,0 @@ -# GitHub diff --git a/community/github/intro.md b/community/github/intro.md new file mode 100644 index 0000000..cc9a4d1 --- /dev/null +++ b/community/github/intro.md @@ -0,0 +1,13 @@ +# GitHub + +:::{todo} +1. for extra contributors - A pyOpenSci community member will review your post / contribution. you don't need to request a review. +1. +::: + + +pyOpenSci has a suite of GitHub repositories (repos) that support pyOpenSci processes and content including: + +* website content +* tools that track contributors and keep the website up to date +* peer review diff --git a/community/github/our-repositories.md b/community/github/our-repositories.md new file mode 100644 index 0000000..0aa379a --- /dev/null +++ b/community/github/our-repositories.md @@ -0,0 +1,65 @@ +# Our Repositories + +:::{todo} +Add repositories from the pyOpenSci organization. +::: + +## pyOpenSci GitHub Repository Overview + +pyOpenSci manages multiple GitHub repositories to support various community +activities. Below is a description of each core repository. + +### [Software-review Repository](https://www.pyopensci.org/software-peer-review/) + +The software-review repository is where community package submissions are +peer-reviewed. All submissions are made through GitHub Issues. [Learn more about +our peer review process here.](https://www.pyopensci.org/software-peer-review/) + +:::{important} +Important: If a pyOpenSci core member identifies an issue with the review +submission template, consult both the editorial team and core team before making +any changes. This template's data are processed by a Python workflow, and even +small modifications could disrupt the language processing. +::: + + +### Software-peer-review Guidebook Repository + +This repository hosts our [software peer review guide](https://www.pyopensci.org/software-peer-review/), +which includes instructions and guidelines for authors, editors, the editor in +chief, and the peer review triage team. It also details our peer review policies, +partnerships, and the templates used in the review process. + +### Python-package-guide Repository + +The [python-package-guide repository](https://www.pyopensci.org/python-package-guide/) +contains our community-developed guidelines and tutorials on Python packaging. +These resources are beginner-friendly and reflect best practices. + +### [pyosMeta Repository](https://github.com/pyOpenSci/pyosMeta) + +The pyosMeta repo contains a Python package published on PyPI that tracks our +package review and contributor data. This data is used in a GitHub action to +update our website. + +### [pyopensci.github.io Repository](https://github.com/pyOpenSci/pyopensci.github.io) + +Our website, [pyOpenSci](https://www.pyopensci.org/), is hosted on GitHub and +uses the Jekyll Minimal Mistakes theme. The python packages page, contributor page and peer review team page are all updated automagically using a +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 +dispatch**. + +1. **Packages.yml**: Updates the [Python Packages page](https://www.pyopensci.org/python-packages.html) + by parsing reviews from software-review repository issues. +2. **Contributors.yml**: Updates the [Our Community page](https://www.pyopensci.org/our-community/index.html) + by parsing data from all organization repositories. + +:::{todo} +Update the website contributors guide with general CI and specific Jekyll +information. +::: + +## [Handbook Repository](https://github.com/pyOpenSci/handbook) + +The handbook repository hosts content that helps the community navigate our +online resources and communication channels. diff --git a/community/index.md b/community/index.md index b9f6a6f..f838548 100644 --- a/community/index.md +++ b/community/index.md @@ -2,6 +2,7 @@ :::{toctree} +:hidden: :caption: Social Media Section Social Media @@ -10,7 +11,9 @@ Slack :::{toctree} +:hidden: :caption: GitHub Section -GitHub +GitHub +Our Repos :::