diff options
author | Patrick Georgi <pgeorgi@google.com> | 2024-01-11 17:27:17 +0000 |
---|---|---|
committer | Patrick Georgi <patrick@coreboot.org> | 2024-01-12 21:04:55 +0000 |
commit | 164cf293554a640f11d71b5142b5ce00cbde7220 (patch) | |
tree | 7ef39a5c1d71b8d9938c4be126280e9e1c417e16 | |
parent | 336fd64de75af9d75d829c573b2103d1b54da572 (diff) |
Documentation: Start administrator handbook
Let's spread the work of maintaining various of our services, but to
achieve that, we need to document what needs to be done.
Change-Id: I87021ee62d18fa464f70351ea8bad732889d55f1
Signed-off-by: Patrick Georgi <patrick@coreboot.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/79901
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
-rw-r--r-- | Documentation/infrastructure/admin.md | 52 | ||||
-rw-r--r-- | Documentation/infrastructure/index.md | 2 |
2 files changed, 53 insertions, 1 deletions
diff --git a/Documentation/infrastructure/admin.md b/Documentation/infrastructure/admin.md new file mode 100644 index 0000000000..cb75ad44f5 --- /dev/null +++ b/Documentation/infrastructure/admin.md @@ -0,0 +1,52 @@ +# Operating our services + +## Mailing list moderation + +Our [mailing lists] experience the same barrage of spam mails than any +other email address. We do have a spam filter in front of it, and +since the lists require registration, spam ends up in the moderation +queue. But not only spam ends up there, sometimes users send inquiries +without registering first. It's a custom of the project to let these +through, so that such emails can be discussed. This requires manual +intervention. + +This section describes the tasks related to mailing list management. + +### Registration + +To participate in mailing list moderation, you need to become a list +moderator or owner. This is up for the existing owners to handle and +if you want to contribute in that area, it might be best to bring it +up at the leadership meeting. + +After gaining leadership approval, list admins can add you to the +appropriate group in the [mailing list backend] by selecting the list, +then User / group-name, and add your email address there. + +### Regular tasks + +Most of our lists are auto-subscribing, so users can register +themselves and finish the process by responding to the double-opt-in +email. Some lists are manually managed though. The [mailing list +backend] shows the number of open subscription requests for these +lists on the mailing list's main page. + +It also provides a list of held messages, where they can be accepted, +rejected or dropped. Spam should be dropped, that's clear. Emails with +huge attachments (e.g. screenshots) should be rejected, which gives +you an opportunity to explain the reason (in case of large +attachments, something like "Please re-send without attachments, offer +the files through some other mechanism please: Our emails are +distributed to hundreds of readers, and sending the files to everybody +is inconsiderate of traffic and storage constraints.") + +Legit emails (often simple requests of the form "is this or that +supported") can be accepted, which means they'll be sent out. + +If you notice recurring spam sources (e.g. marketers) you can put them +on the [global ban list] to filter them out across all lists. It takes +entries in regular expression format. + +[mailing lists]: https://mail.coreboot.org/hyperkitty/ +[mailing list backend]: https://mail.coreboot.org/postorius/ +[global ban list]: https://mail.coreboot.org/postorius/bans/ diff --git a/Documentation/infrastructure/index.md b/Documentation/infrastructure/index.md index 744809f2fd..6748637762 100644 --- a/Documentation/infrastructure/index.md +++ b/Documentation/infrastructure/index.md @@ -5,7 +5,7 @@ This section contains documentation about our infrastructure ## Services * [Project services](services.md) - +* [Administrator's handbook](admin.md) ## Jenkins builders and builds * [Setting up Jenkins build machines](builders.md) |