diff --git a/.gitignore b/.gitignore index 930649c..53c83b2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,10 @@ _build .vscode -*/.ipynb_checkpoints/* +**/.ipynb_checkpoints/* tmp/ .DS_Store .nox __pycache__ /.luarc.json + .ipynb_checkpoints/ diff --git a/README.md b/README.md index e0e15db..073ea3f 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,21 @@ # pyOpenSci Handbook - -[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-) - -![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/governance?color=purple&display_name=tag&style=plastic) - -[![DOI](https://zenodo.org/badge/161679308.svg)](https://zenodo.org/badge/latestdoi/161679308) - -[![CircleCI](https://circleci.com/gh/pyOpenSci/contributing-guide.svg?style=svg)](https://circleci.com/gh/pyOpenSci/contributing-guide) +[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/governance?color=purple&display_name=tag&style=plastic) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7120880.svg)](https://doi.org/10.5281/zenodo.7120880) +[![CircleCI](https://circleci.com/gh/pyOpenSci/handbook.svg?style=svg)](https://circleci.com/gh/pyOpenSci/handbook) ## What is pyOpenSci? -pyOpenSci is devoted to building diverse, supportive community around -the Python open source tools that drive open science. We do this through: +pyOpenSci is a vibrant and diverse open science and open source community of practice. We are file down open science and open source pain points associated with sharing and writing better, more maintainable code and software. + +Our community runs several programs: -* open peer review -* mentorship and -* training. +* [Open peer review of scientific Python software](https://www.pyopensci.org/about-peer-review/index.html) +* [Development of open online education resources for anyone to use.](https://www.pyopensci.org/learn.html) +* [online and in-person training events](https://www.pyopensci.org/events/index.html). pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives. -We draw inspiration from [rOpenSci](https://ropensci.org/), a -community to help promote, teach, and grow best-practices in software development -for the Scientific `R` stack. - -:construction: Construction note :construction: - -This repository is currently under heavy construction. So please note that if -you are working through the content! - -## Contributing statement - ## How to setup @@ -39,23 +23,24 @@ This repository contains the source files for the [pyOpenSci governance handbook ## Build the governance document locally -Our governance documentation is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool. +Our governance documentation is built with [Sphinx](https://sphinx-doc.org), a documentation tool. -The easiest way to build our documentationis to use [the `nox` automation tool](https://nox.thea.codes/), a tool for quickly building environments and running commands within them. +The easiest way to build our documentation is to use [`nox`](https://nox.thea.codes/), a tool for quickly building environments and running commands within them. Using `nox` ensures that your environment has all the dependencies needed to build the documentation. To build, follow these steps: 1. Install `nox` - ```console - $ pip install nox - ``` +```console +$ pip install nox +``` + 2. Build the documentation: - ```console - $ nox -s docs - ``` +```console +$ nox -s docs +``` This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`. @@ -64,11 +49,11 @@ To build live documentation that updates when you update local files, run the fo ```console $ nox -s docs-live ``` -The governance page should automatically open in a new browser window. If it does not, check your terminal for the text "Serving on http://XXX.X.X.X:XXXX". The HTTP address is a link that you can click (or copy and paste into your browser) in order to open the governance page for live editing. +The governance page should automatically open in a new browser window. If it does not, check your terminal for the text "Serving on http://XXX.X.X.X:XXXX". The HTTP address is a link that you can click (or copy and paste into your browser) to open the handbook page for live editing. ## Contributing to this guide -We welcome and issues and pull-requests to improve the content of this guide. +We welcome issues and pull requests to improve the content of this guide. If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/governance/issues/new/choose). ## Contributors ✨ @@ -94,4 +79,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! diff --git a/governance/index.md b/governance/index.md index 09c4b61..05a4bfa 100644 --- a/governance/index.md +++ b/governance/index.md @@ -1,14 +1,14 @@ -# Governance +# Governance, Structure & Values ## About -pyOpenSci is an non-profit organization whose mission is to build diverse, +pyOpenSci is a fiscally sponsored nonprofit organization whose mission is to build diverse, supportive community around the free and open Python tools that drive open science. pyOpenSci supports open science through -* **Open Peer review:** pyOpenSci runs an open peer review process lead by volunteer editors and reviewers. This process has several goals including reducing functionality overlap in existing open source tools; supporting long term maintenance of tools and/or carefully sunsetting of tools as needed and increasing the quality of tools built to support scientific workflows. -* **Mentorship:** We will build out a community program where diverse community members are mentored in skills needed to both contribute to open source software which in turn will propel their open science skills forward. +* **Open Peer review:** pyOpenSci runs an open peer review process led by volunteer editors and reviewers. This process has several goals, including reducing functionality overlap in existing open source tools, supporting long-term maintenance of tools and/or carefully sunsetting tools as needed, and increasing the quality of tools built to support scientific workflows. +* **Mentorship:** We will build out a community program where diverse community members are mentored in skills needed to contribute to open source software, which in turn will propel their open science skills forward. * **Training:** pyOpenSci will provide training in skills needed to contribute to open source software. diff --git a/index.md b/index.md index 224bc07..c9a71d0 100644 --- a/index.md +++ b/index.md @@ -10,7 +10,7 @@ that support operations of pyOpenSci. :gutter: 3 ::::{grid-item} -:::{card} ✿ Our Structure and Values ✿ +:::{card} ✿ Governance, Structure and Values ✿ :class-card: left-aligned :link: organization/index :link-type: doc @@ -20,12 +20,24 @@ Learn more about the governance structure of pyOpenSci. :::: ::::{grid-item} -:::{card} ✿ Community ✿ +:::{card} Our Community :class-card: left-aligned :link: community/index :link-type: doc -Learn more our community. +Learn more about the vibrant pyOpenSci open science & open source community of practice. +::: +:::: + +::::{grid-item} +:::{card} Our Organization +:link: organization/index +:link-type: doc +:class-card: left-aligned + + **This section is under heavy development!** + +Learn about how we work, the platforms we use, and how we engage with the community. ::: :::: @@ -51,7 +63,7 @@ local development builds of content in individual pyOpenSci repositories. :::: ::::{grid-item} -:::{card} ✿ ✨ Meeting Notes✨ +:::{card} Meeting Archives :class-card: left-aligned :link: reference/index.html @@ -60,31 +72,21 @@ we were developing and founding pyOpenSci. ::: :::: -::::{grid-item} -:::{card} ✿ See our peer review guide ✨ -:class-card: left-aligned -:link: - -This guide will walk you through the editorial process. -::: -:::: - ::::: ## Why pyOpenSci? -pyOpenSci promotes open and reproducible research through peer-review of -scientific Python packages. We also build technical capacity by providing a +pyOpenSci promotes open and reproducible research through [peer review of +scientific Python packages](https://www.pyopensci.org/about-peer-review/index.html). We also build technical capacity by providing a curated repository of high-quality packages and enabling scientists to write and share their own software. We hope to foster a greater sense of community -among scientific Python users so that we can help each other become better +among scientific Python users to help each other become better programmers and researchers. :::{toctree} :hidden: -:caption: Mission, Leadership, Code of Conduct -Governance & Values +Structure & Values ::: :::{toctree} @@ -103,7 +105,7 @@ Organization :::{toctree} :hidden: -:caption: Contributing +:caption: Contribute Code of Conduct Contributing diff --git a/organization/index.md b/organization/index.md index b850bd7..8bc25f2 100644 --- a/organization/index.md +++ b/organization/index.md @@ -1,7 +1,7 @@ -# Organization +# pyOpenSci Organization Processes & Structure :::{toctree} -:hidden: +:maxdepth: 2 :caption: Platforms Canva @@ -10,11 +10,10 @@ Bitwarden ::: :::{toctree} -:hidden: :caption: Internal Documentation +:maxdepth: 2 - -Google Drive +Internal Platforms External Communication ::: diff --git a/organization/internal-documentation.md b/organization/internal-documentation.md index ff2ecdf..27db6a2 100644 --- a/organization/internal-documentation.md +++ b/organization/internal-documentation.md @@ -1,6 +1,17 @@ # Storing internal pyOpenSci documents -Google Drive, a part of the pyOpenSci Google Workspace plan, is where all pyOpenSci documents, spreadsheets, google slides, photos, and graphics are stored. These documents include, but are not limited to: +pyOpenSci uses Google Workspace to support day-to-day organization operations. pyOpenSci using workspace for: + +* Email accounts and +* Google Drive for file storage + +Workspace implements 2-factor authentication. + +## Google Drive: Storing internal pyOpenSci documents + +Google Drive, a part of the pyOpenSci Google Workspace plan, is where all pyOpenSci documents, spreadsheets, google slides, photos, and some graphics are stored. + +These documents include, but are not limited to: * branding guidelines * event planning documents @@ -8,6 +19,14 @@ Google Drive, a part of the pyOpenSci Google Workspace plan, is where all pyOpen * slides that support talks and presentations * and more. -As a pyOpenSci staff member, you should store any documents related to pyOpenSci in the **pyos-shared** Google Shared Drive. Storing documents in the **pyos-shared** drive ensures that all pyOpenSci employees can access, edit, and use these documents. Storing these documents in the shared drive also supports program task redundancy, as the document's owner is the organization in that drive rather than an individual user. Storing documents in a shared drive owned by the organization helps pyOpenSci staff jump in and help another staff person in the event of a needed but unplanned absence (e.g., a medical emergency or an unexpected family issue). +:::{note} +See our page on [Canva](canva) for more about producing and storing graphics. +::: + +### Organization Google Drive structure + +All pyOpenSci staff members should work on and store pyOpenSci-related documents in the **pyos-shared** Google Shared Drive. Storing documents in the **pyos-shared** drive ensures that all pyOpenSci employees can access, edit, and use these documents. + +Storing these documents in the shared drive also supports program task redundancy, as the document's owner is the organization in that drive rather than an individual user. Storing documents in a shared drive owned by the organization helps pyOpenSci staff jump in and help another staff person in the event of a needed but unplanned absence (e.g., a medical emergency or an unexpected family issue). -Employees can save personal documents such as 1-on-1 agendas and notes, personal notes, and other information that does not need to be shared at the organizational level in their personal drive. +Employees can save personal documents such as 1-on-1 agendas and notes, personal notes, and other information that do not need to be shared at the organizational level in their pyOpenSci individual drive and share them with other team members as needed.