Added README for meetings directory
Added README for the `meetings` directory where the yaml files for each meeting is located. The README includes a link to the OpenStack Meeting page on the wiki, a link to the meeting yaml files on OpenStack git site, as well as brief explanation on the content inside a yaml file. The description of the yaml content now uses | to perserve the "list" structure. This section is further edited so that `*` are used to format these bulleted list of agenda items instead of `-`. Change-Id: Iab1af314dc979394bd4a61caccf902cc92bf3735
This commit is contained in:
parent
263799cbde
commit
d91e7e843c
96
README.rst
96
README.rst
|
@ -3,8 +3,10 @@ Gerrit-Powered-Agenda
|
|||
|
||||
This project aims to provide an easier way to manage OpenStack team meetings.
|
||||
Currently, each team's meeting time and agenda are listed at:
|
||||
https://wiki.openstack.org/wiki/Meetings. This project replaces each meeting
|
||||
with well-defined YAML files.
|
||||
|
||||
https://wiki.openstack.org/wiki/Meetings.
|
||||
|
||||
This project replaces each meeting with well-defined YAML files.
|
||||
|
||||
This tool will run as a Jenkins job, so that each time a YAML meeting is
|
||||
created, Jenkins will generate an iCal file.
|
||||
|
@ -28,7 +30,7 @@ meeting, see the meetings/README file.
|
|||
|
||||
To run this tool, run
|
||||
|
||||
$ python jobs.py
|
||||
`$ python jobs.py`
|
||||
|
||||
in the gerrit-powered-agenda directory.
|
||||
|
||||
|
@ -41,3 +43,91 @@ When this project is complete, this tool will run as a Jenkins job. A developer
|
|||
wishing to create a meeting will push a YAML file to Gerrit, which will then be
|
||||
reviewed. If the review passes, Jenkins will run this tool to generate ical
|
||||
files.
|
||||
|
||||
YAML Meeting File
|
||||
=================
|
||||
|
||||
Refer to the meetings page on the OpenStack Wiki for a list of meetings:
|
||||
|
||||
https://wiki.openstack.org/wiki/Meetings
|
||||
|
||||
For a list of yaml meeting files, visit
|
||||
|
||||
https://git.openstack.org/cgit/openstack-infra/gerrit-powered-agenda/tree/meetings
|
||||
|
||||
Each meeting consists of:
|
||||
|
||||
* `project` -- the name of the project
|
||||
* `schedule` -- a list of schedule each consisting of
|
||||
- `time` -- time string in UTC
|
||||
- `day` -- the day of week the meeting takes place
|
||||
- `irc` -- the irc room in which the meeting is held
|
||||
- `frequency` -- frequent occurence of the meeting
|
||||
* `chair` -- name of the meeting's chair
|
||||
* `description` -- a paragraph description about the meeting
|
||||
* `agenda` -- a paragraph consisting of the bulleted list of topics
|
||||
|
||||
The file name should be a lower-cased, hyphenated version of the meeting name,
|
||||
ending with `.yaml` or `.yml`. For example, `Keystone team meeting` should be
|
||||
saved under `keystone-team-meeting.yml`.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
This is an example for the yaml meeting for Nova team meeting. The whole file
|
||||
will be import into Python as a dictionary.
|
||||
|
||||
* The project name is shown below.
|
||||
|
||||
::
|
||||
|
||||
project: Nova Team Meeting
|
||||
|
||||
* The schedule is a list of dictionaries each consisting of `time` in UTC,
|
||||
`day` of the week, the `irc` meeting room, and the `frequency` of the
|
||||
meeting. Options for the `frequency` are `weekly`, `biweekly-even`, and
|
||||
`biweekly-odd` at the moment.
|
||||
|
||||
::
|
||||
|
||||
schedule:
|
||||
- time: '1400'
|
||||
day: Thursday
|
||||
irc: openstack-meeting-alt
|
||||
frequency: weekly
|
||||
|
||||
- time: '2100'
|
||||
day: Thursday
|
||||
irc: openstack-meeting
|
||||
frequency: weekly
|
||||
|
||||
* The chair is just a one liner. The might be left empty if there is not a chair.
|
||||
|
||||
::
|
||||
|
||||
chair: Russell Bryant
|
||||
|
||||
* The project description is as follows. Use `>` to for the parapraph so new
|
||||
lines are folded.
|
||||
|
||||
::
|
||||
|
||||
description: >
|
||||
This meeting is a weekly gathering of developers working on OpenStack.
|
||||
Compute (Nova). We cover topics such as release planning and status,
|
||||
bugs, reviews, and other current topics worthy of real-time discussion.
|
||||
|
||||
* The project agenda is show below. Note the use of `|` to treat the agenda as
|
||||
a paragraph where newlines are perserved. Currently we plan to use * to
|
||||
format the list of item so it is similar to the wiki format. Add additional
|
||||
for each level of sublist items. I.e. `**` for a sub-item and `***` for a
|
||||
sub-item of a sub-item.
|
||||
|
||||
::
|
||||
|
||||
agenda: |
|
||||
* general annoucement
|
||||
* sub-teams
|
||||
* bugs
|
||||
* blueprints
|
||||
* open discussion
|
||||
|
|
Loading…
Reference in New Issue