@@ -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+
217222Past 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
359367Guidance 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,60 @@ bot will update the channel with a link to a build bot when a build goes from
392401passing to failing and again when the build goes from failing back to passing.
393402It 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
413+ on `
the LLVM community calendar <
https://calendar.google.com/calendar/u/0/[email protected] >`_
414+ to Discord. This behavior is controlled on a per-event basis, by metadata in the
415+ event's description. Each piece of metadata should be on its own line in the
416+ event description.
417+
418+ The currently supported metadata is:
419+
420+ - ``discord-bot-event-type `` - **Required **. Specifies the event type. Valid
421+ values are ``office-hours `` and ``sync-up ``.
422+ - ``discord-bot-channels-to-mention `` - **Sometimes required **. A
423+ comma-separated list of Discord channels to post notifications in. If your
424+ ``discord-bot-event-type `` is ``office-hours ``, the ``#office-hours `` channel
425+ will be implicitly appended to this list (ergo, you don't need to specify this
426+ item). Otherwise, you must specify a value here.
427+ - ``discord-bot-mention `` - **Optional **. A comma-separated list of people to
428+ ping on each event notification. All names mentioned must be Discord
429+ usernames, and must have a leading ``@ ``. e.g., ``@foo, @bar ``.
430+ - ``discord-bot-reminder-time-before-start `` - **Optional **. The number of
431+ minutes before the beginning of an event to send a ping. This should be
432+ formatted as an integer. Defaults to 30.
433+ - ``discord-bot-message `` - **Optional **. Text to append to all event pings.
434+
435+ An example of an event description with valid metadata is::
436+
437+ Regular office hours to chat with people about LLVM! We can help with
438+ questions, troubleshooting bugs, etc.
439+
440+ discord-bot-channels-to-mention: #beginners, #foo
441+ discord-bot-event-type: office-hours
442+ discord-bot-mention: @gburgessiv, @bar
443+ discord-bot-message: Come join us for office hours!
444+ discord-bot-reminder-time-before-start: 5
445+
446+ This metadata will prompt the Discord bot to:
447+
448+ * send pings 5 minutes before the given event starts, mentioning ``@gburgessiv ``
449+ and ``@bar `` in the ping
450+ * send the pings to the ``#beginners ``, ``#foo ``, and ``#office-hours `` channels
451+ * include the text "Come join us for office hours!" in the ping
452+
453+ A few minutes before sending a ping, the bot will double-check that the event
454+ hasn't been cancelled.
455+
456+ If you need help troubleshooting, or have feature requests/questions, please
457+ feel free to ping @gburgessiv!
395458
396459.. _meetups-social-events :
397460
@@ -485,6 +548,10 @@ Please put the following pieces of information in your calendar invite:
485548* If you have meeting minutes for your event, add a pointer to where those live.
486549 A good place for meeting minutes could be as a post on LLVM Discourse.
487550
551+ * If you're hosting a sync-up or office hours event and would like it to be
552+ announced by the Discord bot, add the relevant metadata (full descriptions
553+ available in the :ref: `discord-bot-event-pings ` section).
554+
488555An example invite looks as follows
489556
490557.. code-block :: none
@@ -500,3 +567,8 @@ An example invite looks as follows
500567
501568 Organizer(s): First Surname ([email protected] ) 502569
570+ discord-bot-channels-to-mention: #lldb
571+ discord-bot-event-type: sync-up
572+ discord-bot-mention: @host-username, @another-host
573+ discord-bot-message: Come join us to chat about LLDB!
574+ discord-bot-reminder-time-before-start: 30
0 commit comments