opendev
/
yaml2ical
Code Issues Proposed changes

Update docs to indicate requirements and expand example meeting 

Update the documentation to note which elements of the yaml
are required.  Also added the agenda_url and project_url keys
to the main doc list.

Lastly, updated the meeting/example.yaml to show usage of the new
duration, agenda_url, and project_url keys

Change-Id: Ifaa9f029ae920b22aa60ab3d47d14982707285d9
This commit is contained in:
Brian (bex) Exelbierd 2015-06-22 22:50:00 +02:00
parent f2ac69f2e3
commit 81c242b7e0
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.rst
View File

@ -117,16 +117,18 @@ YAML Meeting File
Each meeting consists of:
* ``project``: the name of the project
* ``project``: the name of the project [MANDATORY]
* ``schedule``: a list of schedule each consisting of
* ``time``: time string in UTC
* ``duration``: duration of the meeting in minutes
* ``day``: the day of week the meeting takes place
* ``irc``: the irc room in which the meeting is held
* ``frequency``: frequent occurrence of the meeting
* ``chair``: name of the meeting's chair
* ``description``: a paragraph description about the meeting
* ``time``: time string in UTC [MANDATORY]
* ``duration``: duration of the meeting in minutes; defaults to 60
* ``day``: the day of week the meeting takes place [MANDATORY]
* ``irc``: the irc room in which the meeting is held [MANDATORY]
* ``frequency``: frequent occurrence of the meeting [MANDATORY]
* ``chair``: name of the meeting's chair [MANDATORY]
* ``description``: a paragraph description about the meeting [MANDATORY]
* ``agenda_url``: a link to the agenda page for the meeting
* ``project_url``: a link to the project home page for the meeting
The file name should be a lower-cased, hyphenated version of the meeting name,
ending with ``.yaml`` . For example, ``Keystone team meeting`` should be

5
meetings/example.yaml
View File

@ -1,9 +1,12 @@
project: Example Team Meeting
agenda_url: http://agenda.com/
project_url: http://project.com
schedule:
- time: '1600'
duration: 45
day: Wednesday
irc: openstack-meeting
frequency: weekly
chair: John Doe
description: >
If you're interested in Example, we have a weekly meeting for you to attend.
If you're interested in Example, we have a 45 minute long weekly meeting for you to attend.