Skip to content

Commit

Permalink
docs: link to GitHub project boards (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer authored Mar 3, 2022
1 parent a0753e0 commit ada613a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 7 deletions.
1 change: 1 addition & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
"pylint",
"pytest",
"qrules",
"roadmap",
"Scikit",
"scipy",
"sympify",
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,8 @@ def get_minor_version(package_name: str) -> str:
linkcheck_ignore = [
"http://127.0.0.1:8000",
"https://open.vscode.dev",
"https://github.com/orgs/ComPWA/projects/5", # private
"https://github.com/orgs/ComPWA/projects/6", # private
]

# Settings for myst_nb
Expand Down
19 changes: 12 additions & 7 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -560,13 +560,18 @@ also the place where you can
### Issue management

We keep track of issue dependencies, time estimates, planning, pipeline
statuses, et cetera with [ZenHub](https://app.zenhub.com). You can use your
GitHub account to log in there and automatically get access to the issue boards
of the packages once you are part of the
[ComPWA organization](https://github.com/ComPWA).

ZenHub issue information is only visible once you log in on ZenHub. Still
publicly visible on GitHub are:
statuses, et cetera with GitHub project boards
([GitHub Issues](https://github.com/features/issues)). The main project boards
are:

- [Public roadmap](https://github.com/orgs/ComPWA/projects/4)
- [Development planning](https://github.com/orgs/ComPWA/projects/5) [private]
- [Infrastructure & Maintenance](https://github.com/orgs/ComPWA/projects/6)
[private]

Some boards are not public. To get access, you can request to become member of
the [ComPWA](https://github.com/ComPWA) GitHub organization. Other information
that is publicly available are:

- [Issue labels](https://github.com/ComPWA/ampform/labels): help to categorize
issues by type (maintenance, enhancement, bug, etc.). The labels are also
Expand Down

0 comments on commit ada613a

Please sign in to comment.