Skip to content

Commit 62443d8

Browse files
committed
Set up team compass site
0 parents  commit 62443d8

File tree

10 files changed

+177
-0
lines changed

10 files changed

+177
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# This file was created automatically with `myst init --gh-pages` 🪄 💚
2+
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3+
4+
name: MyST GitHub Pages Deploy
5+
on:
6+
push:
7+
# Runs on pushes targeting the default branch
8+
branches: [main]
9+
env:
10+
# `BASE_URL` determines the website is served from, including CSS & JS assets
11+
# You may need to change this to `BASE_URL: ''`
12+
BASE_URL: /${{ github.event.repository.name }}
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
21+
concurrency:
22+
group: 'pages'
23+
cancel-in-progress: false
24+
jobs:
25+
deploy:
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v4
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v3
34+
- uses: actions/setup-node@v4
35+
with:
36+
node-version: 18.x
37+
- name: Install MyST Markdown
38+
run: npm install -g mystmd
39+
- name: Build HTML Assets
40+
run: myst build --html
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: './_build/html'
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# MyST build outputs
2+
_build

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# The Jupyter Foundation Board Team Compass
2+
3+
This is the Team Compass for the Jupyter Foundation Board, for more information on what that means, see [the contributing guidelines](doc/contribute.md) for more information.

doc/contribute.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# How to contribute to the team compass
2+
3+
We strongly encourage the Foundation Board to edit this documentation so that remains up-to-date and has useful information in it. The way to do so is by opening a pull request on GitHub. Here are two ways to do so:
4+
5+
## Local workflow
6+
7+
### Clone this repository
8+
9+
```bash
10+
git clone https://github.com/jupyter-governance/jupyter-foundation-governing-board
11+
cd jupyter-foundation-governing-board
12+
```
13+
14+
### Install MyST
15+
16+
```bash
17+
pip install -r requirements.txt
18+
```
19+
20+
### Preview the documentation locally
21+
22+
```bash
23+
cd doc
24+
myst start
25+
```
26+
27+
### Commit your changes and push them to the repository
28+
29+
```bash
30+
git commit -m "Updating docs"
31+
git push
32+
```
33+
34+
### Open a pull request on GitHub
35+
36+
Finally, open a pull request to propose the changes.
37+
38+
## GitHub workflow
39+
40+
If you'd like to skip working locally, you can propose edits to the documentation directly from GitHub.
41+
To do so, go to the following URL, which will open the repository in a VSCode instance running in the cloud:
42+
43+
[github.dev/jupyter-governance/jupyter-foundation-governing-board](https://github.dev/jupyter-governance/jupyter-foundation-governing-board)
44+
45+
Make the edits there, then use the VSCode interface to commit and push the changes to the repository.

doc/home.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# The Jupyter Foundation Board Team Compass
2+
3+
This is the Team Compass for the Board of the [Jupyter Foundation](https://jupyterfoundation.org). It is the source of truth for the group's plans, practices, and policies. It is also a place where we share notes and updates from our work.
4+
5+
:::{note} Work in progress
6+
This Team Compass is very young and still a work in progress. It is likely missing many things, and contributions are welcome!
7+
:::
8+
9+
## Where information is located
10+
11+
- [Our GitHub repository](https://github.com/jupyter-governance/jupyter-foundation-governing-board) has all the source files for this team compass.
12+
- [The Governing Board Google Drive folder](https://drive.google.com/drive/folders/1RIBUYQk8xN1-vHs4bqLM8Chj8tWOfM90?usp=drive_link) has most of our working documents.

doc/media/images/favicon.png

522 Bytes
Loading

doc/media/images/foundation-dark.svg

Lines changed: 22 additions & 0 deletions
Loading

doc/media/images/foundation.svg

Lines changed: 22 additions & 0 deletions
Loading

doc/myst.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# See docs at: https://mystmd.org/guide/frontmatter
2+
version: 1
3+
project:
4+
id: 43701336-c290-46b0-8e48-6528e15b5fcc
5+
# title:
6+
# description:
7+
# keywords: []
8+
# authors: []
9+
title: Jupyter Foundation Board Team Compass
10+
github: https://github.com/jupyter-governance/jupyter-foundation-governing-board
11+
toc:
12+
- file: home.md
13+
- title: Meeting Notes
14+
children:
15+
- file: meetings/2025.md
16+
- file: contribute.md
17+
# To autogenerate a Table of Contents, run "myst init --write-toc"
18+
site:
19+
template: book-theme
20+
options:
21+
favicon: media/images/favicon.png
22+
logo: media/images/foundation.svg
23+
logo_dark: media/images/foundation-dark.svg

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mystmd

0 commit comments

Comments
 (0)