Page MenuHomePhabricator

Overhaul Mailman documentation
Closed, ResolvedPublic

Description

Looking over https://wikitech.wikimedia.org/wiki/Lists.wikimedia.org - it needs to be changed.

A few main points;

  • Disable lists section skips the mailman interface as the main method of doing this. The method listed is mostly damaging, causing inconsistencies and so on. Ops can disable a list via shell but the method list is a mix of correct and breaking. Re-enabling the list fixes it however.
  • Configuration section is just giving a 'wow so out of date' vibe. Just like to puppet at the very worst case anyway. Let's not dupe things twice.
  • Seems to be a working pad for lily->sodium too. Not the best when we're working on sodium->fermium right now :)
  • Probably set up a user-side documentation as well. Technical docs are great but when they are the only source of information for things like spamassassin, it's terrible linking people to it.

In short; rewrite everything and get bad practice out of people. It does more harm than good.

Event Timeline

JohnLewis claimed this task.
JohnLewis raised the priority of this task from to High.
JohnLewis updated the task description. (Show Details)
JohnLewis added subscribers: JohnLewis, Dzahn, RobH.

They should also come under this task ideally then to improve them if need be. History goes back to 2004 and looking at it, seems mostly the same content so best to verify.

To resolve a main issue right now; here is a very quick modification to the documentation I'll apply (noting here as well).

Disabling a list should be the following commands:

echo "advertised=0" | config_list -i /dev/stdin $list
echo "emergency=1"  | config_list -i /dev/stdin $list
echo "member_moderation_action=2" | config_list -i /dev/stdin $list
echo "generic_nonmember_action=2" | config_list -i /dev/stdin $list

At least the meta and wikitech pages should link to each other in prominent places. Or maybe they can just be merged into a single thing with "for users" and "for admins" sections (some people are both!). It's not even clear to me why it has to be split between meta and wikitech.

JohnLewis raised the priority of this task from High to Needs Triage.Sep 1 2015, 10:10 PM

<snip>

It's not even clear to me why it has to be split between meta and wikitech.

I think there are three audiences for 'mailing list' documentation.... the users (readers), the admins (moderators), and the technical support people (operations, ???). Some people could span all these roles.

Ideally it would be easy to find for all :-) (Where is not as important as the ability to find it and/or know it exists.)

Cheers, Richard.

i made some changes on the wikitech page, replacing "sodium" with "fermium, some lighttpd stuff with Apache...

as always with "fix docs on wiki"-tickets they are open-ended

Looking over this a bit more. I'm going to try and get this done over the weekend starting Friday.

I'm also going to aim to get https://meta.wikimedia.org/wiki/Mailing_lists/Standardization up to standard and get it out of a draft into a technical policy seeing as we have inconsistencies in list (even new ones!).

Wikitech documentation seems done to me now!

Going to work on Meta-Wiki docs and see what I can spin up from there.

Meta-Wiki is done.

The blocker for this now (in my opinion) is proposing a new https://meta.wikimedia.org/wiki/Mailing_lists/Standardization and then putting it for a community review. Since we can't really block meta-tech work on a community consensus, I'll close this ticket once a new draft goes up.

and with https://meta.wikimedia.org/wiki/Mailing_lists/Standardization I am going to call this closed! (a documentation ticket actually meeting an end, shocking).