Skip to content

Commit d4d6bcc

Browse files
committed
[llvm][Docs] add discord bot capability notes
The LLVM Discord bot now has the ability to scrape the LLVM calendar & send reminders about upcoming office hours events and sync-ups. Document that here. While I'm in the area, add a note about the bot's ability to @mention people when they're on buildbot blamelists. Related to llvm/Community.o#19
1 parent bfa711a commit d4d6bcc

File tree

1 file changed

+66
-4
lines changed

1 file changed

+66
-4
lines changed

llvm/docs/GettingInvolved.rst

Lines changed: 66 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,11 @@ what to add to your calendar invite.
214214
- `ics <https://drive.google.com/file/d/1ten-u-4yjOcCoONUtR4_AxsFxRDTUp1b/view?usp=sharing>`__
215215
- `Meeting details/agenda: <https://docs.google.com/document/d/1Glzy2JiWuysbD-HBWGUOkZqT09GJ4_Ljodr0lXD5XfQ/edit>`__
216216

217+
218+
For event owners, our Discord bot also supports sending automated announcements
219+
of upcoming sync-ups. Please see the :ref:`discord-bot-event-pings` section for
220+
info.
221+
217222
Past online sync-ups
218223
^^^^^^^^^^^^^^^^^^^^
219224

@@ -355,6 +360,9 @@ The :doc:`CodeOfConduct` applies to all office hours.
355360
- `Google meet <https://meet.google.com/nga-uhpf-bbb>`__
356361
- English
357362

363+
For event owners, our Discord bot also supports sending automated announcements
364+
of upcoming office hours. Please see the :ref:`discord-bot-event-pings` section
365+
for info.
358366

359367
Guidance for office hours hosts
360368
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -365,10 +373,11 @@ Guidance for office hours hosts
365373
:ref:`llvm-community-calendar`.
366374
Please see :ref:`llvm-community-calendar-host-guidance` for more guidance on
367375
what to add to your calendar invite.
368-
* When starting an office hours session, consider typing something like "*Hi,
369-
I'm available for chats in the next half hour at* video chat URL. *I'm
370-
looking forward to having conversations on the video chat or here.*" on the
371-
the `#office-hours Discord channel <https://discord.com/channels/636084430946959380/976196303681896538>`__.
376+
* When starting an office hours session, if you haven't set up the Discord bot
377+
integration, consider typing something like "*Hi, I'm available for chats in
378+
the next half hour at* video chat URL. *I'm looking forward to having
379+
conversations on the video chat or here.*" on the
380+
`#office-hours Discord channel <https://discord.com/channels/636084430946959380/976196303681896538>`__.
372381

373382
Doing this can help:
374383
* overcome potential anxiety to call in for a first time,
@@ -392,6 +401,59 @@ bot will update the channel with a link to a build bot when a build goes from
392401
passing to failing and again when the build goes from failing back to passing.
393402
It is a great way to actively monitor the status of the build.
394403

404+
The bot also supports @mention-ing you when your email appears on a blamelist.
405+
For more details, DM ``help`` to the bot.
406+
407+
.. _discord-bot-event-pings:
408+
409+
Discord bot event pings
410+
^^^^^^^^^^^^^^^^^^^^^^^
411+
412+
Our Discord bot supports automatically sending messages about upcoming events on
413+
Discord. This behavior is controlled on a per-event basis, by metadata in the
414+
event's description. Each piece of metadata should be on its own line in the
415+
event description.
416+
417+
The currently-supported metadata is:
418+
419+
- ``discord-bot-event-type`` - **Required**. Specifies the event type. Valid
420+
values are ``office-hours`` and ``sync-up``.
421+
- ``discord-bot-channels-to-mention`` - **Sometimes required**. A
422+
comma-separated list of Discord channels to post notifications in. If your
423+
``discord-bot-event-type`` is ``office-hours``, the ``#office-hours`` channel
424+
will be implicitly appended to this list (ergo, you don't need to specify this
425+
item). Otherwise, you must specify a value here.
426+
- ``discord-bot-mention`` - **Optional**. A comma-separated list of people to
427+
ping on each event notification. All names mentioned must be Discord
428+
usernames, and must have a leading ``@``. e.g., ``@foo, @bar``.
429+
- ``discord-bot-reminder-time-before-start`` - **Optional**. The number of
430+
minutes before the beginning of an event to send a ping. This should be
431+
formatted as an integer. Defaults to 30.
432+
- ``discord-bot-message`` - **Optional**. Text to append to all event pings.
433+
434+
An example of an event description with valid metadata is::
435+
436+
Regular office hours to chat with people about LLVM! We can help with
437+
questions, troubleshooting bugs, etc.
438+
439+
discord-bot-channels-to-mention: #beginners, #foo
440+
discord-bot-event-type: office-hours
441+
discord-bot-mention: @gburgessiv, @bar
442+
discord-bot-message: Come join us for office hours!
443+
discord-bot-reminder-time-before-start: 5
444+
445+
This metadata will prompt the Discord bot to:
446+
447+
* send pings 5 minutes before the given event starts, mentioning ``@gburgessiv``
448+
and ``@bar`` in the ping
449+
* send the pings to the ``#beginners``, ``#foo``, and ``#office-hours`` channels
450+
* include the text "Come join us for office hours!" in the ping
451+
452+
A few minutes before sending a ping, the bot will double-check that the event
453+
hasn't been cancelled.
454+
455+
If you need help troubleshooting, or have feature requests/questions, please
456+
feel free to ping @gburgessiv!
395457

396458
.. _meetups-social-events:
397459

0 commit comments

Comments
 (0)