🔥🚚 modules(matrix): Remove Matrix WG docs
This commit removes the Fedora Matrix Working Group docs from the Community Ops Team docs site. This is because the Fedora Matrix WG is launching its own Fedora Docs site as its own component, and the deleted pages in this commit are now moved over to that site. ref: docs/docs-fp-o#56 Signed-off-by: Justin Wheeler <jwheel@redhat.com>
This commit is contained in:
parent
57675bad99
commit
14c2a25666
5 changed files with 1 additions and 150 deletions
|
|
@ -23,7 +23,6 @@ nav:
|
|||
- modules/analytics/nav.adoc
|
||||
- modules/events/nav.adoc
|
||||
- modules/flock/nav.adoc
|
||||
- modules/matrix/nav.adoc
|
||||
- modules/teams/nav.adoc
|
||||
- modules/outreach-badges/nav.adoc
|
||||
- modules/design-assets/nav.adoc
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
* xref:index.adoc[Events]
|
||||
** xref:2024-events.adoc[2024 events]
|
||||
** xref:sop-ambassadors.adoc[Ambassador Best Practices]
|
||||
** xref:matrix-event-bot.adoc[Pretix Matrix event bot]
|
||||
** xref:marketing::sops/stream-uploads.adoc[Processing Livestreams]
|
||||
** xref:marketing::sops/stream-uploads.adoc[Processing Livestreams ^[🡵\]^]
|
||||
** xref:fedocal.adoc[Fedocal]
|
||||
|
|
|
|||
|
|
@ -1,73 +0,0 @@
|
|||
= Matrix Event Bot
|
||||
Adrian Edwards (moralcode); Justin W. Wheeler (jflory7)
|
||||
:page-aliases: workflows:matrix-event-bot.adoc
|
||||
|
||||
Fedora transitioned its virtual events (e.g. Release Parties) to Pretix (for ticketing) and Matrix (for communication) in May 2024, starting with the Fedora Linux 40 Release Party.
|
||||
The manual process used then was to periodically download CSV data from Pretix and sort through it in a spreadsheet to determine who had not been invited yet.
|
||||
This happened while attendees continued to register leading up to and during the event.
|
||||
|
||||
To help make this work more efficient for future volunteers, a https://github.com/fedora-infra/maubot-pretix-invite[Matrix bot] was created to assist with automating this process.
|
||||
This document aims to serve as a high-level overview of how to set up and make use of the bot for event organizers.
|
||||
|
||||
|
||||
[[bot-setup]]
|
||||
== Bot Setup and Infrastructure
|
||||
|
||||
The bot is implemented as a plugin for the popular Matrix bot platform https://docs.mau.fi/maubot/index.html[Maubot], the same system that https://github.com/fedora-infra/matrix-bots/[other fedora Matrix bots] are made with.
|
||||
The instructions for setting up the bot are largely the same regardless of where it runs and can be found in the https://github.com/fedora-infra/maubot-pretix-invite#basic-setup[README].
|
||||
|
||||
Ultimately, the goal is for this bot to be run on Fedora-managed infrastructure alongside the existing bots (such as meetbot and zodbot) so that the task of bot hosting and setup can be taken off the shoulders of event organizers.
|
||||
|
||||
If you would like to host an instance of the bot yourself, it is helpful to have the following things ready before starting:
|
||||
|
||||
- A Matrix account to use for the bot (one can be obtained from the current Fedora Community Architect to avoid using a personal one tied to a FAS login)
|
||||
- The ability to access Pretix and manage the event that you plan to use the bot with
|
||||
- (Optionally, for additional automation) a public facing web domain that you can point at the bot
|
||||
|
||||
|
||||
[[communishift]]
|
||||
=== Running on Communishift
|
||||
|
||||
If you are planning to use xref:infra::pages/communishift.adoc[Communishift] to host the bot for multiple fedora events, be aware that some https://github.com/fedora-infra/maubot-pretix-invite/milestone/1[additional work] may still needed to fully support multiple events, as well as GDPR considerations.
|
||||
|
||||
[[gdpr]]
|
||||
==== GDPR Considerations
|
||||
|
||||
When hosting on Communishift, you should also be aware of Communishift's policy on Personal Information.
|
||||
This section is based on https://pagure.io/fedora-infrastructure/issue/11970[this] communishift provisioning ticket.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
This bot does require processing, and potentially storing, a very limited set of personal information.
|
||||
You may have some additional responsibilities as the organizer of the event (or operator of the bot) in the event that someone chooses to exercise their rights under the GDPR.
|
||||
====
|
||||
|
||||
*What information does the bot process?*
|
||||
The bot fetches the Pretix order identifier and the users Matrix ID from Pretix.
|
||||
|
||||
*What information does the bot store?*
|
||||
The bot may store the Pretix order identifier in memory or on disk.
|
||||
The bot does not directly store the users Matrix ID, however their Matrix ID may still appear in the bot's logs (there is an https://github.com/fedora-infra/maubot-pretix-invite/issues/8[open issue] to address this)
|
||||
|
||||
*Why is this information needed and how is it used?*
|
||||
The Pretix order identifer is used for the purposes of allowing the bot to avoid repeat-processing of duplicate orders.
|
||||
The user's Matrix ID is used in order to invite the user to the Matrix room.
|
||||
https://github.com/fedora-infra/maubot-pretix-invite?tab=readme-ov-file#setting-up-an-event[The directions in the README] mention that event organizers should add help text next to the Matrix ID prompt to both inform the user that this is how their Matrix ID wil be used, and also direct them to enter it in the correct format.
|
||||
|
||||
|
||||
[[usage]]
|
||||
== Bot Usage
|
||||
The bot aims to be as simple as possible for event organizers to use and has a few basic commands.
|
||||
|
||||
Prior to the event, the bot needs to be given a few pieces of information:
|
||||
|
||||
. What Matrix rooms you want to use for the event
|
||||
. How the bot should connect to Pretix
|
||||
|
||||
This information is provided via commands such as `!setroom` and `!authorize`.
|
||||
The bot also has a few convenience commands for checking the status of various aspects of the bot, as well as a command to mass-invite users from Pretix.
|
||||
|
||||
For full documentation about the commands available, see the https://github.com/fedora-infra/maubot-pretix-invite?tab=readme-ov-file#basic-usage-and-commands[Usage section of the README].
|
||||
|
||||
One notable drawback of the bot with regard to commands is that, in order to prevent event attendees from messing with the bot, the bot is set up to only respond to commands that are given by Matrix accounts specifically listed in the bot's configuration.
|
||||
There is an https://github.com/fedora-infra/maubot-pretix-invite/issues/9[open issue] to improve this.
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
* xref:index.adoc[Matrix @ Fedora WG]
|
||||
//** xref:staff-nomination-criteria.adoc[Mod/Admin Nominations]
|
||||
|
|
@ -1,72 +0,0 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Matrix @ Fedora CommOps Working Group
|
||||
|
||||
A CommOps Working Group focused on the governance and user experience of Fedora's presence on the Matrix platform.
|
||||
This group concentrates on establishing policy, developing best practices, and providing support for Fedora's Matrix spaces and moderation teams, rather than directly executing all moderation tasks.
|
||||
|
||||
|
||||
[[scope]]
|
||||
== Scope
|
||||
|
||||
The primary goals of this working group are to:
|
||||
|
||||
* Establish clear guidelines and policies for the creation, moderation, and maintenance of official `fedoraproject.org` Matrix rooms.
|
||||
* Provide support and resources to Matrix room admins and moderators.
|
||||
* Develop best practices for moderation, including tools and techniques to address abuse and ensure a safe environment.
|
||||
* Facilitate communication and collaboration between Matrix room admins and moderators.
|
||||
* Collaborate with the CommOps team to align Matrix governance with broader Fedora communication strategies.
|
||||
* Improve the overall user experience within Fedora's Matrix presence.
|
||||
|
||||
|
||||
[[responsibilities]]
|
||||
== Responsibilities
|
||||
|
||||
The working group has the following responsibilities:
|
||||
|
||||
* Define the criteria for a Matrix room to be considered an official `fedoraproject.org` room.
|
||||
* Develop and maintain documentation for Matrix room governance and moderation practices.
|
||||
* Define and document the process for nominating and approving Matrix room admins and moderators.
|
||||
* Evaluate and recommend tools and methods for abuse prevention and moderation support.
|
||||
* Organize regular meetings for Matrix room admins and moderators to discuss issues, share best practices, and facilitate support.
|
||||
* Coordinate with the CommOps team on communication strategies and support needs.
|
||||
* Identify and recommend potential improvements to Matrix chat bots used by the community.
|
||||
* Facilitate communication and collaboration primarily with other Fedora Project teams, Special Interest Groups (SIGs), and Working Groups regarding Matrix usage, governance, and best practices.
|
||||
* Engage with external open source communities on shared moderation tools or common challenges when beneficial for Fedora.
|
||||
|
||||
|
||||
[[membership]]
|
||||
== Membership
|
||||
|
||||
The working group includes participants from the following groups:
|
||||
|
||||
* Representatives from the CommOps team.
|
||||
* Active Matrix room admins and moderators for official Fedora spaces.
|
||||
* Representatives from the Fedora Infrastructure team.
|
||||
* Other interested Fedora contributors.
|
||||
|
||||
Contributors interested in participating are encouraged to join the discussions in the `#commops:fedoraproject.org` room and attend CommOps Team meetings.
|
||||
|
||||
|
||||
[[operating-procedures]]
|
||||
== Operating Procedures
|
||||
|
||||
* The working group uses the xref:council::index.adoc#decisions[lazy consensus model] for its internal decisions.
|
||||
* The working group uses the `#commops:fedoraproject.org` Matrix room for its discussions.
|
||||
* The working group uses the CommOps Team repository at https://forge.fedoraproject.org/commops/tickets to manage tasks and track progress.
|
||||
|
||||
|
||||
[[meetings]]
|
||||
== Meetings
|
||||
|
||||
The Matrix WG meets as a part of the CommOps Team meetings.
|
||||
The CommOps Team meetings alternate between video conferences and text-based sessions on Matrix, resulting in approximately one video meeting and one text-based meeting per month.
|
||||
Meeting schedules are announced in the `#commops:fedoraproject.org` Matrix room.
|
||||
|
||||
|
||||
[[commops]]
|
||||
== Relationship to CommOps
|
||||
|
||||
* This working group operates under the umbrella of the Fedora Community Operations (CommOps) team.
|
||||
* It aligns its activities with CommOps' goals to improve communication and community health.
|
||||
* CommOps provides guidance and support to the working group.
|
||||
Loading…
Add table
Add a link
Reference in a new issue