summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorThierry Carrez <thierry@openstack.org>2017-08-04 15:53:45 +0200
committerThierry Carrez <thierry@openstack.org>2017-08-04 15:53:45 +0200
commitdea7fb4dd9fd3313a2d0798f2a8901daea4ebab2 (patch)
tree771a04c125da53f76cc2b5bd5016c0422e0d2c0f /README.rst
parentcf7dd084a68a3b12de825deb29b7101d2aee6b54 (diff)
Move admin commands from ! to ~
Due to an unfortunate bot command character collision, move admin commands from ! to ~. Take the opportunity to properly document them. Change-Id: Ida77e6262e6da9dade64e6ff9ebca1e41b291b30
Notes
Notes (review): Code-Review+2: Jeremy Stanley <fungi@yuggoth.org> Workflow+1: Jeremy Stanley <fungi@yuggoth.org> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 04 Aug 2017 14:05:38 +0000 Reviewed-on: https://review.openstack.org/490874 Project: openstack/ptgbot Branch: refs/heads/master
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst44
1 files changed, 38 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index f3c6f58..21dfb02 100644
--- a/README.rst
+++ b/README.rst
@@ -3,13 +3,24 @@ OpenStack PTG Bot
3================= 3=================
4 4
5ptgbot is the bot that PTG room moderators use to surface what's 5ptgbot is the bot that PTG room moderators use to surface what's
6currently happening at the event. Commands follow the following format:: 6currently happening at the event. Room operators send messages to
7the bot, like::
7 8
8 #ROOMNAME [now|next] TOPIC 9 #swift now discussing ring balancing
9 10
10From that information the bot builds a static webpage with discussion 11and from that information the bot builds a static webpage with discussion
11topics currently discussed ("now") and an indicative set of discussion 12topics currently discussed ("now") and an indicative set of discussion
12topics coming up next ("next"). 13topics coming up next ("next"). It also merges information from the
14reservable rooms ethercalc in order to produce a single, static,
15mobile-friendly page.
16
17Room operators commands
18=======================
19
20You have to have voice in the channel (+v) to send commands to the ptgbot.
21Commands follow the following format::
22
23 #ROOMNAME [now|next] TOPIC
13 24
14Please note that: 25Please note that:
15 26
@@ -31,8 +42,29 @@ Example::
31 #swift next at 3pm we plan to cover cold storage features 42 #swift next at 3pm we plan to cover cold storage features
32 43
33 44
34Testing 45Admin commands
35======= 46==============
47
48You have to ve a channel operator (+o) to use admin commands.
49
50~list
51 List available room names
52
53~add ROOM [ROOM..]
54 Add new room name(s)
55
56~del ROOM [ROOM..]
57 Deletes room name(s)
58
59~clean ROOM [ROOM..]
60 Removes active entries for specified room(s)
61
62~wipe
63 Resets the database entirely (removes all defined rooms and entries)
64
65
66Local testing
67=============
36 68
37Copy config.json.sample to config.json:: 69Copy config.json.sample to config.json::
38 70