Skip to content

Commit 25fbbd0

Browse files
committed
Minor comments
1 parent bc43e94 commit 25fbbd0

3 files changed

Lines changed: 5 additions & 6 deletions

File tree

docs/bootstrap-governance/governance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Governance of Executable Books
22

33
```{note}
4-
_All contributors_ to the Executable Books Project (including but not limited to individuals contributing code, providing technical support, teaching workshops, and engaging in discussions about changes to EBP policy or the MyST Specification) adhere to the [Code of Conduct](policy:coc).
4+
_All contributors_ to the Executable Books Project (including but not limited to individuals contributing code, providing technical support, teaching workshops, and engaging in discussions about changes to EBP policy or the MyST Specification) are expected to adhere to the [Code of Conduct](policy:coc).
55
```
66

77
This page describes the groups of people with decision-making authority in the project, as well as the Sources of Truth for organizational policy and the process around changing it.
@@ -84,7 +84,7 @@ Team Policy is defined at the [`executablebooks/team-compass`](https://github.co
8484

8585
Our Team Compass is the Source of Truth (SoT) for all organizational policy[^1]. The Team Compass should make it clear what is _policy_ and what is _guidance_. It should define clear sections that are community "musts" and others that are "guidelines and recommendations".
8686

87-
It can also delegate SoT status to other places in the organization. It delegates the SoT for the MyST specification to `myst-specification/`.
87+
It can also delegate SoT status to other places in the organization. It delegates the SoT for the MyST specification to `myst-spec/`.
8888

8989
[^1]: A Team Compass is common in the Jupyter ecoystem (e.g., [here is JupyterHub's Team Compass](https://jupyterhub-team-compass.readthedocs.io/en/latest/index-team_guides.html). In fact, Jupyter's governance model will soon [require that sub-projects have their own Team Compass](https://jupyter.org/governance/software_subprojects.html?responsibilities-of-jupyter-subprojects)
9090

@@ -122,9 +122,9 @@ Take the following steps for changing any policy, strategy, or governance aspect
122122

123123
### The MyST Specification
124124

125-
The MyST Specification is defined at [`executablebooks/myst-specification`](https://github.com/executablebooks/myst-specification). The process for changing it is defined at [`executablebooks/myst-enhancement-proposals`](https://github.com/executablebooks/myst-enhancement-proposals).
125+
The MyST Specification is defined at [`executablebooks/myst-spec`](https://github.com/executablebooks/myst-spec). The process for changing it is defined at [`executablebooks/myst-enhancement-proposals`](https://github.com/executablebooks/myst-enhancement-proposals).
126126

127-
`executablebooks/myst-specification` is the Source of Truth for the MyST Specification. It uses a combination of documentation, examples, schemas, tests, etc to define MyST markdown in a form that others could use to implement parsers and renderers. It is versioned and includes "releases" in order to make it easy for downstream implementors to track the changes they need to make.
127+
`executablebooks/myst-spec` is the Source of Truth for the MyST Specification. It uses a combination of documentation, examples, schemas, tests, etc to define MyST markdown in a form that others could use to implement parsers and renderers. It is versioned and includes "releases" in order to make it easy for downstream implementors to track the changes they need to make.
128128

129129
```{admonition} Implementation detail
130130
This repository will need to be modified as-needed to be the source of truth for the MyST Specification, and to have enough information to teach newcomers about its structure and function. One example for inspiration: [the Zarr specifications page](https://zarr.readthedocs.io/en/stable/spec.html). [Here's a comment with some suggestions for what is missing](https://github.com/executablebooks/meta/pull/843#issuecomment-1275474229).

docs/bootstrap-governance/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# A bootstrap decision-making process and source of truth for Executable Books
22

3-
43
:::{note}
54

65
This is a proposal for bootstrapping a formal decision-making and team policy process.

docs/bootstrap-governance/meps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ This process is encoded in `executablebooks/myst-enhancement-proposals` and desc
6969
- If the MEP is accepted:
7070
- Update its status metadata to `Accepted` and merge the PR.
7171
- Once a PR is merged, it closes the issue and a decision has been made.
72-
- The changes in the MEP then become "part of the myst spec" via a Pull Request to `myst-specification` that anyone is welcome to implement.
72+
- The changes in the MEP then become "part of the myst spec" via a Pull Request to `executablebooks/myst-spec` that anyone is welcome to implement.
7373
- If there are unresolved objections (via `Request Changes` to the PR)
7474
- The MEP author may restart the voting process after incorporating feedback to resolve the objection, **or** ask the Steering Council to follow the same [decision-making process used for team policy](governance:policy-decision).
7575

0 commit comments

Comments
 (0)