From 81c242b7e0716cb1cd256b087b2ef06786603238 Mon Sep 17 00:00:00 2001 From: "Brian (bex) Exelbierd" Date: Mon, 22 Jun 2015 22:50:00 +0200 Subject: [PATCH] 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 --- README.rst | 18 ++++++++++-------- meetings/example.yaml | 5 ++++- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index d44d8f7..22b7b79 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/meetings/example.yaml b/meetings/example.yaml index 7d5f939..4264d40 100644 --- a/meetings/example.yaml +++ b/meetings/example.yaml @@ -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.