From 0c432c30c043a335dcc215ecb7a98c0cfd43ce88 Mon Sep 17 00:00:00 2001 From: Anil Belur Date: Thu, 7 Jun 2018 08:02:13 +1000 Subject: [PATCH] Add section for MeetBot guide MeetBot Guide: - Start and end a meeting - Take notes - Post-meeting work Ref: https://wiki.acumos.org/display/MEET/Meetbot+Tips JIRA: RELENG-876 Change-Id: I94486a1edd821f511d4cb84ceec18df50d8d486b Signed-off-by: Anil Belur --- docs/conf.py | 1 + docs/index.rst | 1 + docs/meetbot.rst | 114 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 docs/meetbot.rst diff --git a/docs/conf.py b/docs/conf.py index 9c658db..7795392 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,6 +28,7 @@ linkcheck_ignore = [ 'https://jenkins.acumos.org.*', 'https://.*.example.org.*', 'https://git.opendaylight.org/gerrit/#/settings/gpg-keys', + 'https://wiki.debian.org/meetbot', # SNI link needs Python 2.7.9+ ] def setup(app): diff --git a/docs/index.rst b/docs/index.rst index 2b1d8c8..fa64970 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Guides: jenkins project-documentation nexus2 + meetbot .. TODO Jenkins (RELENG-510) .. TODO Release Workflow (RELENG-511) diff --git a/docs/meetbot.rst b/docs/meetbot.rst new file mode 100644 index 0000000..d7b1c64 --- /dev/null +++ b/docs/meetbot.rst @@ -0,0 +1,114 @@ +.. _meetbot-guide: + +############# +MeetBot Guide +############# + +LF Project communities use `MeetBot `_ to take +notes and to manage meetings on IRC. + +To host a meeting, join `#-meeting` on irc.freenode.org and take notes +on the public IRC channel. It's recommended that all meetings participants assist +with the task of taking notes. This reduces the onus of the task on a single +person since its difficult to take notes and act as the chair of the meeting +at the same time. + +MeetBot uploads the meeting minutes and raw IRC logs are to the +`LF IRC log server `_ and +are available under the directory IRC channel (e.g. for #-meeting). + +.. _meetbot-start-end-meeting: + +Start and end a meeting +======================= + +* To start a meeting, use a ``#startmeeting `` command followed + by meeting name. + +* Use ``#chair `` to assign one or more meeting chairs. + + Meeting chairs have the ability to moderate the meeting and allows them to + use commands such as ``#startmeeting``, ``#endmeeting``, ``#topic``, + ``#startvote``, ``#endvote``. + +* Use ``#endmeeting`` to end the meeting. + + This frees up MeetBot to run other meetings in the channel and posts the + links to the HTML and raw minutes to the channel. + +.. _meetbot-take-notes: + +Take notes +========== + +* Use ``#topic`` to set a discussion topic. + + This command automatically changes the topic and closes the previous + discussion item. + + .. code-block:: none + + #topic Review Action Items + + .. note:: + + The chair of the meeting has to set the topic. + +* Use ``#info`` to record a note. + + .. code-block:: none + + #info dneary suggested using MeetBot for meeting minutes + +* Use ``#agree `` to record agreements to document consensus. + + .. code-block:: none + + #agreed promote the user X as committer on project Y + + .. note:: + + The chair of the meeting has to record agreements. + +* Use ``#link`` to link to external resources in the minutes. + + .. code-block:: none + + #link http://wiki.opnfv.org/wiki/MeetBot + +* Use ``#action`` to record action items. + + This creates a summary section at the end of the meeting, summarizing the + action items by assignee. Include the user names in the action to mark an + assignee to a action item. + +* Use ``#startvote `` and ``#endvote`` to start/end voting. + + .. code-block:: none + + #startvote Do you approve a 15 minute coffee break? (+1, 0, -1) + + Voters will use ``#vote