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
8 changes: 4 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ jobs:
pip install -r requirements.txt


# Build the book
- name: Build the book
# Build the site
- name: Build the MyST site
run: |
jupyter-book build .
cd docs && myst build --html

# Upload artifact
- uses: actions/upload-artifact@v4
with:
name: html_docs
path: ./_build/html
path: ./docs/_build/html
20 changes: 16 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,26 @@ jobs:
run: |
pip install -r requirements.txt

# Build the book
- name: Build the book
# Build the site
- name: Build the MyST site
env:
BASE_URL: /${{ github.event.repository.name }}
run: |
jupyter-book build .
cd docs && myst build --html

# Generate redirects from old URLs to new URLs
- name: Generate redirects
run: |
python scripts/generate_redirects.py "https://jupyter.org/governance/" "docs/_build/redirects"

# Copy redirects into the build directory
- name: Merge redirects into build
run: |
cp -r docs/_build/redirects/* docs/_build/html/

# Push the book's HTML to github-pages
- name: GitHub Pages action
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_build/html
publish_dir: ./docs/_build/html
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,24 @@ See [the governance introduction](intro.md) for license information.
## Infrastructure for this repository

The content in this repository is hosted online with `github-pages`, and the HTML
files are built with [jupyter-book](https://jupyterbook.org). To build and preview
these documents locally, install the latest version of Jupyter Book with:
files are built with [MyST](https://mystmd.org). To build and preview
these documents locally, you can use [nox](https://nox.thea.codes):

```
pip install -U jupyter-book
```bash
# Build the documentation
nox -s docs

# Or serve with live reload
nox -s docs-live
```

and build the book with:
Alternatively, install MyST directly and build manually:

```
cd path/to/this/repo
jupyter-book build .
```bash
pip install -r requirements.txt
cd docs
myst build --html
```

The resulting website will be in `_build/html`, which you can explore by opening
The resulting website will be in `docs/_build/html`, which you can explore by opening
any of the `.html` files that are created.
34 changes: 0 additions & 34 deletions _config.yml

This file was deleted.

23 changes: 0 additions & 23 deletions _plausible.py

This file was deleted.

47 changes: 0 additions & 47 deletions _toc.yml

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ by e-mailing
[*[email protected]*](mailto:[email protected])
within 24 hours.

(reporting)=
## Reporting

If you believe someone is violating the code of conduct, please report this in
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
70 changes: 70 additions & 0 deletions docs/myst.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
version: 1
project:
title: Project Jupyter Governance
copyright: ""
github: https://github.com/jupyter/governance
license: CC0-1.0
exclude:
- LICENSE.md
- README.md
- .github

toc:
- file: intro.md
title: Introduction

# Governance Section
- title: Governance
children:
- file: overview.md
- file: executive_council.md
- file: software_steering_council.md
- file: jupyter_foundation.md
- file: software_subprojects.md
children:
- file: list_of_subprojects.md
- file: newsubprojects.md
- file: standing_committees_and_working_groups.md
children:
- file: list_of_standing_committees_and_working_groups.md
- file: communitybuildingworkinggroup.md
- file: distinguished_contributors.md
- file: people.md

# Code of Conduct Section
- title: Code of Conduct
children:
- file: conduct/code_of_conduct.md
children:
- file: conduct/enforcement.md
- file: conduct/reporting_online.md
- file: conduct/reporting_events.md
- file: conduct/faq.md

# Organizational Policy Section
- title: Organizational Policy
children:
- file: decision_making.md
- file: papers.md
- file: trademarks.md
- file: projectlicense.md

# Previous Governance Section
- title: Archive
children:
- file: linux-proposal.md
title: Linux Foundation Proposal
- file: archive/governance.md
title: Previous Governance
children:
- file: bootstrapping_subproject_councils.md
- file: bootstrapping_executive_council.md

site:
template: book-theme
title: Project Jupyter Governance
options:
logo_text: Project Jupyter
actions:
- title: Edit on GitHub
url: https://github.com/jupyter/governance/edit/main/docs
2 changes: 2 additions & 0 deletions newsubprojects.md → docs/newsubprojects.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ official capacity?
The two paths for official Subproject creation are now detailed.


(direct-subproject-creation)=
## Direct Subproject creation

In some cases, Steering Council members can immediately create new official Subprojects in the main
Expand All @@ -72,6 +73,7 @@ The process is completed when the Executive Council approves a PR that adds the
[^example]: [Here's an example PR](https://github.com/jupyter/governance/pull/229) from the jupyter-book incorporation process.


(incorporation-of-an-existing-external-subproject)=
## Incorporation of an existing external Subproject

In other cases, Subprojects proposed for incorporation will have existed and been developed as
Expand Down
2 changes: 1 addition & 1 deletion overview.md → docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For more details, see the [Standing Committees and Working Groups document](stan
### Union of Councils

The Union of Councils represents the combination of councils, sub-councils, and working groups in Jupyter.
See [](#union-of-councils) for more information.
See [the Union of Councils section](#union-of-councils) for more information.


### Distinguished Contributors
Expand Down
File renamed without changes.
Loading