Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] add page for working groups #458

Merged
merged 8 commits into from
Sep 28, 2024
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
76 changes: 76 additions & 0 deletions data/working_groups.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
# template
# - title:
# goal:
# open_letter:
# communication_channel:
# url:
# chairs:
# - name:
# email:
# - name:
# email:
# status:
# outcome:
# - url:
# - url:
#

# ACTIVE

# - title: BIDS 2.0
# goal: Discussions and suggestions of backwards incompatible changes to BIDS
# open_letter: TBD
# communication_channel: TBD
# url: https://github.com/bids-standard/bids-2-devel
# chairs:
# - name: Yaroslav Halchenko
# email: debian@onerussian.com
# status: active

# - title: Governance amendments
# goal: Clarification of the BEP process
# open_letter: TBD
# communication_channel: TBD
# url:
# chairs:
# - name:
# email:
# status: active

- title: Code of conducts amendments
goal: Update and uniformizations of the BIDS code of conducts
open_letter: https://docs.google.com/document/d/1mxtijf1khONdU23phKfMpIwk-RTDQ07eVpJsMHemoLA/edit
communication_channel: TBD
url: https://docs.google.com/document/d/1Cj9trFifGNqyNtpyEO9FfJLlmDGTbUy5enRAA9rTyH4/edit?usp=sharing
chairs:
- name: Ariel Rokem
email: arokem@uw.edu
- name: Dora Hermes
email: doraharmes@gmail.com
status: active

- title: BIDS online presence
goal: Streamline online resources based on community feedback
open_letter: https://docs.google.com/document/d/1lN9hu5ufpkkkD41XXWrH_tnEXlKUlJaZNQBYF3OtV9M/edit?usp=sharing
communication_channel: TBD
url:
chairs:
- name: Eric Earl
email: eric.earl@nih.gov
- name: Christine Rogers
email: rogers@bic.mni.mcgill.ca
status: active

# DISSOLVED

- title: Governance amendment
goal: Update the BIDS governance
open_letter: https://docs.google.com/document/d/18PpfSgcHckqejTZsRZlEDlJ_yD3JiwSQ8kCjVXorg6U/edit#heading=h.6tz42cdj5asc
communication_channel:
url: https://docs.google.com/document/d/18PpfSgcHckqejTZsRZlEDlJ_yD3JiwSQ8kCjVXorg6U/edit#heading=h.6tz42cdj5asc
chairs:
- name: Rémi Gau
email: remi.gau@gmail.com
status: dissolved
outcome: '[Pull request](https://github.com/bids-standard/bids-website/pull/346)'
29 changes: 15 additions & 14 deletions docs/collaboration/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,20 +224,21 @@ they should inform the steering group in advance and are responsible to help:

### Other working/interest Groups

A working/interest group can be established under the approval of the
BIDS Steering Group. This is typically but not limited to being formed
for the purpose of advancing the BIDS community, not the standard. Each
group will appoint 1-2 chairs. Members of these groups can have cross
appointments in other groups (for example, BEP Working Group). These groups do
not necessarily dissolve after some duration or event, unless stated in
their proposal.

The working/interest group formation is formalized through an open
letter via a "read-only" Google Document addressed to the BIDS Steering
Group. The open letter will be posted on:
the [BIDS-Specification GitHub repository](https://github.com/bids-standard/bids-specification),
[Google Group](https://groups.google.com/forum/#!forum/bids-discussion),
and [social media channels](<https://github.com/bids-standard/bids-specification?tab=readme-ov-file#BIDS-communication-channels>).
A working/interest group can be established under the approval of the BIDS Steering Group.
This is typically but not limited to being formed for the purpose of advancing the BIDS community, not the standard.

Each group will appoint 1-2 chairs.
Members of these groups can have cross appointments in other groups (for example, BEP Working Group).
These groups do not necessarily dissolve after some duration or event, unless stated in their proposal.

The working/interest group formation is formalized
through an open letter via a "read-only" Google Document addressed to the BIDS Steering Group.
The open letter will be posted on:

- the [BIDS-Specification GitHub repository](https://github.com/bids-standard/bids-specification),
- [Google Group](https://groups.google.com/forum/#!forum/bids-discussion),
- and [social media channels](<https://github.com/bids-standard/bids-specification?tab=readme-ov-file#BIDS-communication-channels>).

This proposal will state what their group aims and goals are.

### BIDS Community
Expand Down
21 changes: 21 additions & 0 deletions docs/collaboration/working-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# BIDS Working groups

BIDS working groups are typically formed (but not limited to)
for the purpose of advancing the BIDS community, not the standard.

This could be a to set up and organize a local BIDS chapter,
to improve the documentation around BIDS...

## Forming a working group

The rules to form a working group are mentioned in the [governance](./governance.md#other-workinginterest-groups).

A template for the open-letter can be found in [this google doc](https://docs.google.com/document/d/1JfTliUcpyRAGdiZSHObkvZFdkrxPTclQTvolr8ssNHM/edit).

## Active working groups

{{ MACROS___generate_working_groups_table(file="working_groups.yml", status="active") }}

## Past working groups

{{ MACROS___generate_working_groups_table(file="working_groups.yml", status="dissolved") }}
4 changes: 2 additions & 2 deletions docs/contact/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Some example questions that have already been answered include:

- [:simple-bluesky: Bluesky](https://bsky.app/profile/bidsstandard.bsky.social/)
- [:simple-mastodon: Mastodon](https://fosstodon.org/@bidsstandard/)
- [:simple-x: Twitter/ X](https://x.com/BIDSstandard)
- [:simple-youtube: YouTube](https://www.youtube.com/embed/-c4PUhTwmz4)
- [:simple-x: Twitter / X](https://x.com/BIDSstandard)
- [:simple-youtube: YouTube](https://www.youtube.com/channel/UCxZUcYfd_nvIVWAbzRB1tlw)
- [:simple-instagram: Instagram](https://www.instagram.com/bidsstandard)
- Listen to our [podcast](https://anchor.fm/bids-maintenance)

Expand Down
2 changes: 2 additions & 0 deletions macros/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
generate_grants_table,
generate_members_table,
generate_tools_table,
generate_working_groups_table,
)
from .main import define_env

Expand All @@ -16,4 +17,5 @@
"generate_beps_table",
"generate_grants_table",
"generate_apps_table",
"generate_working_groups_table",
]
8 changes: 8 additions & 0 deletions macros/macros.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ def generate_beps_table(file: str, type: str | None = None) -> str:
return template.render(include=content, type=type)


def generate_working_groups_table(file: str, status: str | None = None) -> str:
input_file = WEBSITE_DATA_DIR / file
content = yaml.load(input_file)
env = return_jinja_env()
template = env.get_template("working_group_table_md.jinja")
return template.render(include=content, status=status)


def generate_grants_table():
input_file = WEBSITE_DATA_DIR / "grants.yml"
content = yaml.load(input_file)
Expand Down
4 changes: 4 additions & 0 deletions macros/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ def define_env(env):
env.macro(macros.generate_beps_table, "MACROS___generate_beps_table")
env.macro(macros.generate_grants_table, "MACROS___generate_grants_table")
env.macro(macros.generate_apps_table, "MACROS___generate_apps_table")
env.macro(
macros.generate_working_groups_table,
"MACROS___generate_working_groups_table",
)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ nav:
- collaboration/index.md
- specification/code_of_conduct.md
- collaboration/governance.md
- collaboration/working-groups.md
- collaboration/contributors.md
- collaboration/acknowledgments.md
# TODO have a single code of conduct
Expand Down
12 changes: 12 additions & 0 deletions templates/working_group_table_md.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{% if status == "dissolved" %}
| Name | Goal | Lead(s) | Outcome |
| :---: | :---- | :------ | :------ |
{% else %}
| Name | Goal | Lead(s) | communication channel |
| :---: | :---- | :---- | :-------------------- |
{% endif %}
{% for group in include %}
{% if group.status == status %}
| [{{ group.title }}]({{ group.url }}) | {{ group.goal }} | {% for person in group.chairs %} {% if person.email %} [{{ person.name }}](mailto:{{ person.email }}) {% else %} {{ person.name }} {% endif %}<br>{% endfor %} | {% if status == "dissolved" %} {{ group.outcome }} {% else %} {{ group.communication_channel }} {% endif %} |
{% endif %}
{% endfor %}