[Bug 965520] [NEW] Improve installation documentation
Public bug reported: 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. ** Affects: mailman Importance: Undecided Status: New ** Tags: documentation easy mailman3 ** Tags removed: bite-size ** Tags added: easy -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
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). -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
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! -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
** Changed in: mailman Status: New => Confirmed ** Changed in: mailman Importance: Undecided => High ** Changed in: mailman Milestone: None => 3.0.0b2 -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
** Changed in: mailman Milestone: 3.0.0b2 => None -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
The requirement on Ubuntu that you need python-dev packages in order to build Mailman 3 should be added as well -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
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 ? -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
I have documented the mailman installation process . In my documematation virtualenv installation guide is also provided -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
my new branch is lp:~saprativejana/mailman/install_doc please review it and merge it. -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
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. ** Patch added: "Installation Guide" https://bugs.launchpad.net/mailman/+bug/965520/+attachment/4338328/+files/in... -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
** Branch linked: lp:~saprativejana/mailman/installation_guide -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
** Branch linked: lp:~saprativejana/mailman/starting_guide -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
This bug has been moved to the new gitlab repo here: https://gitlab.com/mailman/mailman/issues/11 -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/965520 Title: Improve installation documentation To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/965520/+subscriptions
participants (6)
-
Abhilash Raj -
Barry Warsaw
-
Saprative -
Staffan Ericsson
-
Stephen Turnbull -
Sumana Harihareswara