Improve installation documentation

Reported by Barry Warsaw on 2012-03-26
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
GNU Mailman
High
Unassigned

Bug Description

This page:

http://packages.python.org/mailman/src/mailman/docs/START.html

describes how to install, configure, and start Mailman 3. It's a bit sparse and out-of-date. For example, it doesn't describe all the locations that mailman.cfg is search for. It also doesn't describe installing and running mm3 in a virtualenv. This would make a nice bite-sized bug for someone wanting to contribution to Mailman.

Barry Warsaw (barry) on 2012-03-26
tags: added: easy
removed: bite-size

Some work (done independently, so not addressing either of the specific complaints above, though) is available in

lp:~stephen-xemacs/mailman/beta1-docs

Specifically it adds some documentation of two experimental web UIs, one the docs written by Florian Fuchs for the Admin UI installation, and the other the Hyperkitty archive UI (I think these notes are by Toshio Kuratomi).

On Mar 27, 2012, at 02:36 AM, Stephen Turnbull wrote:

>Some work (done independently, so not addressing either of the specific
>complaints above, though) is available in
>
>lp:~stephen-xemacs/mailman/beta1-docs
>
>Specifically it adds some documentation of two experimental web UIs, one
>the docs written by Florian Fuchs for the Admin UI installation, and the
>other the Hyperkitty archive UI (I think these notes are by Toshio
>Kuratomi).

Thanks for this branch! It looks great and I'm merging it. Just a few minor
style points.

I like double-equal signs at the top level header, e.g.

=====================================
Set Up the Archive UI in Five Minutes
=====================================

Second level headers use single equals, e.g.

Requirements
============

I also fixed a few minor capitalizations and spellings. I also changed things
to use the "Postorius" term for the web ui. I also corrected and moderately
rewrote a few things in START.rst; please take a look.

BTW, is it "hyperkitty" or "HyperKitty" or "Hyperkitty"? We seem to be a
little inconsistent with the spelling (but I'm not sure how to fix it ;).

I also added some of the missing links.

Thanks again for your contribution!

Barry Warsaw (barry) on 2012-04-06
Changed in mailman:
status: New → Confirmed
importance: Undecided → High
milestone: none → 3.0.0b2
Barry Warsaw (barry) on 2012-09-08
Changed in mailman:
milestone: 3.0.0b2 → none

The requirement on Ubuntu that you need python-dev packages in order to build Mailman 3 should be added as well

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers