Skip to content

TEMPLATES_DOCUMENTATION.md

Latest commit

 

History

History
193 lines (132 loc) · 5.47 KB

TEMPLATES_DOCUMENTATION.md

File metadata and controls

193 lines (132 loc) · 5.47 KB

This document contains empty versions of each template needed to successfully create meeting artifacts for a Committee, Working Group, Initiative, or Team. These documents need to go in the /templates directory in this repository.

Template Variables

There are several variables in the documents that need to be configured:

  • <name>: The name of the Committee, Working Group, Initiative, or Team that meeting artifacts are being created for.
  • <shortname>: The abbreviated or shortened name for a group, used in each filename to connect associated files together.
  • <team_name>: The name of the GitHub team in the Node.js org.
  • <calendar event name>: The name of calendar events that mark the group's meeting date/time.
  • <repo>: The repository of the group.
  • <agenda-label>: The label for which to search the Node.js GitHub organization, to add items to the group's agenda.
  • <issue-label>: an optional label for the created issue itself.
  • <observer>: Name of an observer in a group's meetings.

Meeting Properties Reference

The following properties are available in meeting base templates and can be used in meeting issue generation:

  • CALENDAR_FILTER: The name of calendar events that mark the group's meeting date/time
  • ICAL_URL: The ICAL URL for a given meetings' calendar
  • USER: The GitHub username/organization (typically nodejs)
  • REPO: The repository name where meeting issues are created
  • GROUP_NAME: The full name of the Committee, Working Group, Initiative, or Team
  • AGENDA_TAG: The label used to search for agenda items in GitHub issues and PRs
  • HOST: Meeting host information
  • JOINING_INSTRUCTIONS: Instructions for joining the meeting (Zoom links, YouTube streams, etc.)
  • ISSUE_LABEL: Optional label to apply to the created meeting issue

These properties are defined in the meeting_base_<shortname> template files and are substituted when generating meeting issues.

Invited

The GitHub Team to invite. The @mention should be a GitHub Team whose members are all invidiuals who are always invited.

File: invited_<shortname>

* <name> Members: @nodejs/<team_name>

Invited Example

File: invited_commcomm

* CommComm Members: @nodejs/community-committee

Meeting Base

A base of metadata and some content for the issue to be created on time, with agenda items automatically created.

File: meeting_base_<shortname>

CALENDAR_FILTER="<calendar event name>"
ICAL_URL="<ical url>"
USER="nodejs"
REPO="<repo>"
GROUP_NAME="<name>"
AGENDA_TAG=<agenda-label>
JOINING_INSTRUCTIONS="

* link for participants: Will be added a few minutes before meeting starts
* For those who just want to watch: https://www.youtube.com/channel/UCQPYJluYC_sn_Qz_XE-YbTQ/live"

Meeting Base Example

File: meeting_base_commcomm

CALENDAR_FILTER="Node.js Community Committee"
ICAL_URL="<...>"
USER="nodejs"
REPO="community-committee"
GROUP_NAME="Community Committee"
AGENDA_TAG=cc-agenda
JOINING_INSTRUCTIONS="

* link for participants: Will be added a few minutes before meeting starts
* For those who just want to watch: https://www.youtube.com/channel/UCQPYJluYC_sn_Qz_XE-YbTQ/live"

Minutes Base

A basic outline for the meeting minutes to be autogenerated in Google Docs. The only basic change from the default template is the message about what label agenda items are extracted from.

File: minutes_base_<shortname>

## Links

* **Recording**:
* **GitHub Issue**: $GITHUB_ISSUE$
* **Minutes**: $MINUTES_DOC$

## Present

$INVITED$
$OBSERVERS$

## Agenda

## Announcements

*Extracted from **<agenda-label>** labelled issues and pull requests from the **nodejs org** prior to the meeting.

$AGENDA_CONTENT$

## Q&A, Other

## Upcoming Meetings

* **Node.js Foundation Calendar**: https://nodejs.org/calendar

Click `Add to Google Calendar` at the bottom left to add to your own Google calendar.

Minutes Base Example

File: minutes_base_commcomm



## Links

* **Recording**:
* **GitHub Issue**: $GITHUB_ISSUE$
* **Minutes**: $MINUTES_DOC$

## Present

$INVITED$
$OBSERVERS$

## Agenda

## Announcements

*Extracted from **cc-agenda** labelled issues and pull requests from the **nodejs org** prior to the meeting.

$AGENDA_CONTENT$

## Q&A, Other

## Upcoming Meetings

* **Node.js Foundation Calendar**: https://nodejs.org/calendar

Click `Add to Google Calendar` at the bottom left to add to your own Google calendar.

Observers

List meeting observers who will consistently attend meetings as observers. File: observers_<shortname>

* <observer>
* <observer>
* <observer>
(...)

Observers Example

File: observers_commcomm

* @therebelrobot (Oz Haven - observer)
* @ParidelPooya (Pooya Paridel - observer)
* @rykerrumsey (Ryker Rumsey - observer)
* @baez (Behzad Karim - observer)
* @BinarySo1o (Therese Stirling - observer)
* @amiller-gh (Adam Miller - observer)
* @yosuke-furukawa (Yosuke Furukawa - observer)
* @Maurice-Hayward (Maurice Hayward - observer)
* @mikehostetler (Mike Hostetler - observer)
* @sarahkconway (Sarah Conway - observer)
* @Tiriel (Benjamin Zaslavsky - observer)
* @DiegoZoracKy (Diego ZoracKy - observer)
* @ZibbyKeaton (Zibby Keaton - observer)
* @tobyfarley (Toby Farley - observer)
* @Bamieh (Ahmad Bamieh - observer)
* @pchrysa (Chrysa - observer)
* @foadlab (observer)
* @codeekage (Abraham Agiri - observer)
* @Voskan (Voskan Voskanyan - observer)