Skip to content

Commit 2b353ba

Browse files
authored
Detailed notes on content templates (#12)
1 parent 0288be2 commit 2b353ba

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

board-agenda-tool/whimsy.md

+25
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
# Analysis of Whimsy Agenda Tool
22

33
Provide notes about how the Whimsy Agenda Tool functions. In general Whimsy needs to be considered as the source of truth for agenda tool behaviour
4+
5+
## Content Templates
6+
7+
A list of data templates, boilerplates, or other similar workflow content docs that are used in key Whimsy workflow features.
8+
9+
While different tools will obviously implement content templating differently, these templates are directly used in workflows that communicate with users, so will need to be ported or otherwise replaced somehow, along with allowing the relevant users to update the content templates themselves easily.
10+
11+
### Templates in svn::/foundation/board/templates/
12+
13+
- board_agenda.erb - **Chair:** Create New Agenda
14+
- reminder1.mustache - **Chair:** Send Email as first reminder to all PMCs private@ and chair's individual email that are due to report in the current Create New Agenda action.
15+
- reminder2.mustache - **Chair:** Send Email as second reminder to all PMCs private@ and chair's individual email that have not yet posted a report to the upcoming agenda.
16+
- reminder-summary.mustache - **Chair:** Send Email (to board@) that describes what other reporting reminders were just sent by a Chair action (note: this likely needs to be improved, and also sent to board@ not just the Chair, see WHIMSY-428)
17+
- non-responsive.mustache - Chair: Send Email to a PMC that has not reported in recent cycles
18+
- remind-action.erb - **Chair:** Send Email to Action item owners
19+
- remind-officer.mustache - seems unused?
20+
21+
### Templates in git::[whimsy/www/board/agenda/*](https://github.com/apache/whimsy/tree/master/www/board/agenda/)
22+
23+
- change-chair.erb - **Auth'd User:** submit a Change Chair Resolution for their PMC, selecting the new proposed chair name.
24+
- committers_report.text.erb - **Chair:** Send Summary email to committers@ of previous meeting (usually a day after a board meeting)
25+
- establish.erb - **Auth'd User:** Add Item - Establish Project resolution to place in upcoming agenda; allow for Project name, chair, purpose of PMC, list of original PMC members.
26+
- terminate.erb - **Auth'd User:** for Add Item - Terminate Project resolution to place in upcoming agenda.
27+
- todos.json.rb - **Secretary:** After meeting: Send email to all newly appointed PMC chairs from establish or chair change resolutions with onboarding instructions.
28+
- (no existing file) - **Secretary:** After meeting: Send email to any newly appointed non-PMC officer with onboarding instructions (this is an enhancement request.)

0 commit comments

Comments
 (0)