Skip to content
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,6 @@ dmypy.json

# Pyre type checker
.pyre/

# Documentation-specific files
docs/development/conventions.txt
6 changes: 4 additions & 2 deletions docs/about.md → docs/about/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

This is a brief history of the Executable Books project, written with the intention of encoding the provenance and rationale behind our current governance structure.

The Executable Books project began as a collaboration between three universities funded from a single grant.
This team used these resources to develop a collection of tools and standards for communicating ideas with computational narratives in the Jupyter ecosystem and beyond.
The Executable Books project began as a grant-funded collaboration between groups at [The Australian National University](https://anu.edu.au),
[Northern Arizona University](https://nau.edu/), and
[The University of California at Berkeley](https://www.berkeley.edu/).
These teams represented many open source projects in the scientific community, such as [QuantEcon](https://quantecon.org), [QIIME 2](https://qiime2.org/), and [The Jupyter Project](https://jupyter.org/).
This group followed a traditional Principal Investigator model where the vast majority of development on the project came from dedicated time paid for by the grant.

Towards the end of the grant, the team discussed ways to create more pathways for community participation and leadership on the project, and to [transition towards more co-creation of a broader group of people](https://github.com/executablebooks/meta/issues/493), rather than being driven primarily by one grant-funded team.
Expand Down
31 changes: 31 additions & 0 deletions docs/about/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
(contributions)=
# Support for the project

The following organizations have provided financial and in-kind support for this project.
For a list of individuals that have contributed to the project, see [](team.md).

## Financial support

These organizations have provided direct financial support for this project.

:::::{grid}

::::{grid-item}
:columns: 3

:::{image} https://pbs.twimg.com/profile_images/1226944724365447169/MzFpwY5P_400x400.png
:class: float-left mr-2 rounded
:width: 100px
:::
::::

::::{grid-item}
:columns: 9
This project was launched via [a three-year grant from the Sloan Foundation](https://sloan.org/grant-detail/9231).
::::

:::::

## In-kind support

_In the future we wish to create a formal definition of what warrants in-kind support for the project, and list them here_.
13 changes: 11 additions & 2 deletions docs/team.md → docs/about/team.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Team Members
(team)=
# Team members

This project has had contributions from many different people and organizations.
Below we list each, including their present or past roles.

## Steering Council

Expand All @@ -13,4 +16,10 @@ We expect the Steering Council to expand in the future, and this initial Steerin

## Core Team

Currently the core team is [defined in this list of team members](https://executablebooks.org/en/latest/team.html).
The core team is [defined in this list of team members](https://executablebooks.org/en/latest/team.html).

## Emeritus Team Members

These are team members that were once on the Core Team, but no longer wish to have Core Team responsibilities.

_Note: this section is currently empty as no team member has formally left the project, we leave it here to encourage these practices moving forward_.
10 changes: 10 additions & 0 deletions docs/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,13 @@ The Executable Book Project follows a community
[Code of Conduct](https://github.com/executablebooks/.github/blob/master/CODE_OF_CONDUCT.md).
Please use that document as the source of truth for interacting with the EBP
community.

```{button-link} https://github.com/executablebooks/.github/blob/master/CODE_OF_CONDUCT.md
:color: primary
Code of Conduct
```

## Future plans

In the future we aim to create a more formal Code of Conduct reporting process and team of people to respond to CoC violations.
Please monitor and provide feedback in [the `team-compass/` repository](https://github.com/executablebooks/team-compass) as we explore the best path forward.
29 changes: 28 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
html_theme = "sphinx_book_theme"
html_logo = "_static/logo.svg"
html_favicon = "_static/logo-square.png"
html_title = None
html_title = ""
html_static_path = ["_static"]

html_theme_options = {
Expand All @@ -39,3 +39,30 @@
"jb": ("https://jupyterbook.org/en/latest", None),
"meta": ("https://executablebooks.org/en/latest/", None),
}

# -- Extra scripts at build time ---------------------------------------------

from pathlib import Path
from sphinx.application import Sphinx
import os
from sphinx.util import logging
import requests

LOGGER = logging.getLogger("conf")

# Functions that this calls are below
def setup(app: Sphinx):
app.connect("builder-inited", update_contributing)


def update_contributing(app: Sphinx):
"""Downloads the latest version of the contributing guide."""
path_contributing = Path(app.srcdir) / "development/conventions.txt"
if path_contributing.exists():
LOGGER.info("Contributing page exists, delete and re-build to update...")
return
LOGGER.info("Updating conventions page...")
# Grab the latest contributing docs
url_contributing = "https://raw.githubusercontent.com/executablebooks/.github/master/CONTRIBUTING.md"
resp = requests.get(url_contributing, allow_redirects=True)
path_contributing.write_bytes(resp.content)
12 changes: 12 additions & 0 deletions docs/development/conventions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Development guide

This is a guide with helpful guidelines and suggestions for contribution.
It is located [in our `executablebooks/.github` repository](https://github.com/executablebooks/.github) for easy access, and copied below.

---

% This is automatically updated in conf.py
% Skip the first line so we don't double up the headers
```{include} conventions.txt
:start-line: 1
```
1 change: 0 additions & 1 deletion docs/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ Individuals who are particularly interested in the EBP community and have demons
This is intentionally blank for now, we will add more information in the coming weeks.
```


#### Expectations

```{note}
Expand Down
32 changes: 29 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,17 @@
This documentation serves as the **Source of Truth** (SoT) for the Executable Books community policy and strategy, and defines its organizational structure and governance.
It also aims to provide resources that facilitate contribution and coordination among team members.

:::{admonition} Work in progress!
:class: caution

This site is a work in progress, as the project begins to formally define its structure and governance.
Some information may be duplicated or contradictory with information at [executablebooks.org](https://executablebooks.org) - if it is, treat the information here as the source of truth.
[See this GitHub issue to track our progress on this migration](https://github.com/executablebooks/meta/issues/857)
:::

## Goals of the Team Compass

The Team Compass should make our organizational policy and power structures explicit.
The Team Compass should make our organizational policy, structure, and team practices explicit.
It also delegates authority to other groups, processes, and locations.
See the sections below for more information.[^1]

Expand All @@ -15,11 +23,29 @@ The Team Compass is always evolving as our community learns and changes.
To propose a change to the Team Compass, see [](governance:policy-decision).

```{toctree}
:caption: Policies and standards
:maxdepth: 2
code-of-conduct
governance
team
about
about/team
strategy
```

```{toctree}
:caption: Contributor resources
:maxdepth: 2
resources/accounts
resources/communication
development/conventions
meetings/index
```

```{toctree}
:caption: About the project
:maxdepth: 2

about/support
about/history
```

## License
Expand Down
Loading