Improve installation documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
| GNU Mailman |
High
|
Unassigned |
Bug Description
This page:
http://
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.
Related branches
- Barry Warsaw: Needs Fixing on 2015-03-09
-
Diff: 133 lines (+128/-0)1 file modifiedsrc/mailman/doc/START.rst (+128/-0)
- Barry Warsaw: Needs Fixing on 2015-03-15
-
Diff: 166 lines (+161/-0)1 file modifiedsrc/mailman/doc/START.rst (+161/-0)
tags: |
added: easy removed: bite-size |
Stephen Turnbull (stephen-xemacs) wrote : | #1 |
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!
Changed in mailman: | |
status: | New → Confirmed |
importance: | Undecided → High |
milestone: | none → 3.0.0b2 |
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
Sumana Harihareswara (sumanah) wrote : | #4 |
I need to learn how to install Mailman anyway, so this is a good bug for me to try working on. Are there any other branches or references I should look to for topics or material to include? Maybe lp:~andrea-crotti-0/mailman/readthedocs ?
Saprative (saprativejana) wrote : | #7 |
sorry for actually i did not do bzr add so the modification ions where not made in my branch. So please ignore my precvious message.
Abhilash Raj (raj-abhilash1) wrote : | #8 |
This bug has been moved to the new gitlab repo here: https:/
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).