opendev/irc-meetings
Code Issues Proposed changes

Update instructions to match 2020

Browse Source 
Update instructions to match current status and resources.

In particular, avoid to duplicate information about the file format,
since it's maintained in yaml2ical doc.

Change-Id: I90b0283785b5d93f8f2854f2a495cda4eef289c9
This commit is contained in:
Thierry Carrez 2020-03-19 16:27:47 +01:00
parent b5e8bdc092
commit 8326e7a668
1 changed files with 11 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
README.rst
View File

@ -1,86 +1,19 @@
================== ====================
OpenStack Meetings OpenDev IRC Meetings
================== ====================
This project aims to provide an easier way to manage OpenStack team meetings. OpenDev maintains an IRC meeting infrastructure.
Currently, each team's meeting time and agenda are listed at:
https://wiki.openstack.org/wiki/Meetings This repository allows to book a meeting slot and publish it on:
This project replaces each meeting with well-defined YAML files. https://eavesdrop.openstack.org/
Each meeting is described in a YAML file in the meetings/ subdirectory.
YAML Meeting File Format Once merged, changes are processed using the yaml2ical module to generate
======================== ical files and HTML files published on https://eavesdrop.openstack.org .
Each meeting consists of: For more information on yaml2ical meeting file format, please see:
* ``project``: the name of the project https://opendev.org/opendev/yaml2ical
* ``meeting_id``: the name given to the ``#startmeeting`` meetbot command
* ``agenda_url`` the URL to the page with the agenda for the meeting,
usually in the wiki
* ``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 occurrence of the meeting
* ``chair``: name of the meeting's chair
* ``description``: a paragraph description about 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
saved under ``keystone-team-meeting.yaml``.
Example
-------
This is an example of the YAML for the Nova team meeting. The whole file
will be imported 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: biweekly-even
- time: '2100'
day: Thursday
irc: openstack-meeting
frequency: biweekly-odd
* The chair is just a one liner. The might be left empty if there is not a
chair. It's recommended to mention his/her IRC nick.
::
chair: Russell Bryant (russellb)
* The project description is as follows. Use `>` for paragraphs where new
lines are folded, or `|` for paragraphs where new lines are preserved.
::
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.
sample.yaml
-----------
If creating a new YAML meeting file please consider using ``sample.yaml`` and
editing as appropriate.