Skip to content

Commit 90f99cc

Browse files
bnbmhdawson
authored andcommitted
Create TEMPLATES_DOCUMENTATION.md (#12)
* Create TEMPLATES_DOCUMENTATION.md First pass at documenting each template and how to fill it out.
1 parent 0b2c04e commit 90f99cc

File tree

2 files changed

+159
-1
lines changed

2 files changed

+159
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Re-uses make-node-meeting for much of the content generation.
1111
The hardest part to get going is doing the google auth setup
1212
as described in: https://github.com/mhdawson/google-auth-wrapper.
1313

14-
Will add more documentation, when I have time.
14+
Basic documentation for each of the templates lives in [TEMPLATES_DOCUMENTATION.md](./TEMPLATES_DOCUMENTATION.md)
1515

1616
Currently I'm testing out for generation of the Node.js TSC meetings.
1717

TEMPLATES_DOCUMENTATION.md

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
This document contains empy versions of each template needed to successfully create meeting artifacts for a Comittee, Working Group, Initiative, or Team.
2+
3+
There are only four variables in the documents that _need_ to be changed:
4+
5+
- **`<name>`:** The name of the Committee, Working Group, Initiative, or Team that meeting artifacts are being creatd for.
6+
- **`<shortname>`:** The abbreviated or shortened name for a group, used in each filename to connect associated files together.
7+
- **`<team_name>`:** The name of the GitHub team in the Node.js org.
8+
- **`<calendar event name>`:** The name of calednar events that mark the group's meeting date/time.
9+
- **`<repo>`:** The repository of the group.
10+
- **`<agenda-label>`:** The label to search the Node.js GitHub organization for to add items to the group's agenda.
11+
- **`<observer>`:** Name of an observer in a group's meetings.
12+
13+
# Invited
14+
The [GitHub Team](https://help.github.com/articles/about-teams/) to invite. The @mention should be a GitHub Team whose members are all invidiuals who are always invited.
15+
16+
**File:** `invited_<shortname>`
17+
```
18+
* <name> Members: @nodejs/<team_name>
19+
```
20+
21+
## Invited Example
22+
**File:** `invited_commcomm`
23+
```
24+
* CommComm Members: @nodejs/community-committee
25+
```
26+
27+
# Meeting Base
28+
A base of metadata and some content for the issue to be created on time, with agenda items automatically created.
29+
30+
**File:** `meeting_base_<shortname>`
31+
```
32+
CALENDAR_FILTER="<calendar event name>"
33+
CALENDAR_ID="[email protected]"
34+
USER="nodejs"
35+
REPO="<repo>"
36+
GROUP_NAME="<name>"
37+
AGENDA_TAG=<agenda-label>
38+
JOINING_INSTRUCTIONS="
39+
40+
* link for participants: Will be added a few minutes before meeting starts
41+
* For those who just want to watch: https://www.youtube.com/channel/UCQPYJluYC_sn_Qz_XE-YbTQ/live"
42+
```
43+
44+
## Meeting Base Example
45+
**File:** `meeting_base_commcomm`
46+
```
47+
CALENDAR_FILTER="Node.js Community Committee"
48+
CALENDAR_ID="[email protected]"
49+
USER="nodejs"
50+
REPO="community-committee"
51+
GROUP_NAME="Community Committee"
52+
AGENDA_TAG=cc-agenda
53+
JOINING_INSTRUCTIONS="
54+
55+
* link for participants: Will be added a few minutes before meeting starts
56+
* For those who just want to watch: https://www.youtube.com/channel/UCQPYJluYC_sn_Qz_XE-YbTQ/live"
57+
```
58+
59+
# Minutes Base
60+
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.
61+
62+
**File:** `minutes_base_<shortname>`
63+
```
64+
## Links
65+
66+
* **Recording**:
67+
* **GitHub Issue**: $GITHUB_ISSUE$
68+
* **Minutes Google Doc**: $MINUTES_DOC$
69+
70+
## Present
71+
72+
$INVITED$
73+
$OBSERVERS$
74+
75+
## Agenda
76+
77+
## Announcements
78+
79+
*Extracted from **<agenda-label>** labelled issues and pull requests from the **nodejs org** prior to the meeting.
80+
81+
$AGENDA_CONTENT$
82+
83+
## Q&A, Other
84+
85+
## Upcoming Meetings
86+
87+
* **Node.js Foundation Calendar**: https://nodejs.org/calendar
88+
89+
Click `+GoogleCalendar` at the bottom right to add to your own Google calendar.
90+
91+
```
92+
93+
## Minutes Base Example
94+
**File:** `minutes_base_commcomm`
95+
```
96+
97+
98+
## Links
99+
100+
* **Recording**:
101+
* **GitHub Issue**: $GITHUB_ISSUE$
102+
* **Minutes Google Doc**: $MINUTES_DOC$
103+
104+
## Present
105+
106+
$INVITED$
107+
$OBSERVERS$
108+
109+
## Agenda
110+
111+
## Announcements
112+
113+
*Extracted from **cc-agenda** labelled issues and pull requests from the **nodejs org** prior to the meeting.
114+
115+
$AGENDA_CONTENT$
116+
117+
## Q&A, Other
118+
119+
## Upcoming Meetings
120+
121+
* **Node.js Foundation Calendar**: https://nodejs.org/calendar
122+
123+
Click `+GoogleCalendar` at the bottom right to add to your own Google calendar.
124+
```
125+
126+
# Observers
127+
List meeting observers who will consistently attend meetings _as observers_.
128+
**File:** `observers_<shortname>`
129+
```
130+
* <observer>
131+
* <observer>
132+
* <observer>
133+
(...)
134+
```
135+
136+
## Observers Example
137+
**File:** `observers_commcomm`
138+
```
139+
* @therebelrobot (Oz Haven - observer)
140+
* @ParidelPooya (Pooya Paridel - observer)
141+
* @rykerrumsey (Ryker Rumsey - observer)
142+
* @baez (Behzad Karim - observer)
143+
* @BinarySo1o (Therese Stirling - observer)
144+
* @amiller-gh (Adam Miller - observer)
145+
* @yosuke-furukawa (Yosuke Furukawa - observer)
146+
* @Maurice-Hayward (Maurice Hayward - observer)
147+
* @mikehostetler (Mike Hostetler - observer)
148+
* @sarahkconway (Sarah Conway - observer)
149+
* @Tiriel (Benjamin Zaslavsky - observer)
150+
* @DiegoZoracKy (Diego ZoracKy - observer)
151+
* @ZibbyKeaton (Zibby Keaton - observer)
152+
* @tobyfarley (Toby Farley - observer)
153+
* @Bamieh (Ahmad Bamieh - observer)
154+
* @pchrysa (Chrysa - observer)
155+
* @foadlab (observer)
156+
* @codeekage (Abraham Agiri - observer)
157+
* @Voskan (Voskan Voskanyan - observer)
158+
```

0 commit comments

Comments
 (0)