Mailman 3 installation documentation
Hi All,
I have been trying to work on revamping the documentation site we have at https://docs.mailman3.org. It is on https:// but I am not sure why the http->https redirect doesn't work in Readthedocs. I have set it to "serve always from https".
Anyway, it might not look too different right now, but there are some small re-organizations. I have been learning some new ReST and Sphinx tricks and been trying to cross-reference and link various sections and settings. The docs site shows up Mailman's logo now (I didn't even know we could do that ;-).
There is a place1 for all supported Django settings that Postorius and Hyperkitty have. I am also planning to add some common Django settings that often people have to lookup and is not fun for people from non-python backgrounds. Hopefully, it will make lives easier for administrators.
I have reverted my own stupid decision to use "sudo pip3 install" in the docs to instead use virtualenv. The installation docs are going to grow to be more comprehensive.
I am also working on mailman-web project3, which should simply installation process for all the web components using a single project and provide better guidance on Django's settings file management and howto run manage.py commands.
I have added a mailman-web command, which, for those of you familiar with internal details of Django, is going to be our custom manage.py script. It sets up settings correctly and would hopefully reduce the pain of using django-admin and/or finding out the right path for manage.py script. It is still not ready for prime time, but it is usable. Early adopters can play with it if they like!
I would really appreciate if people who have tried to manually install Mailman 3 in the past would share their experiences about what they think could be documented better. You can reply here or open an issue2.
The user documentation are going to follow, hopefully soon :)
-- thanks, Abhilash Raj (maxking)
Hurrah! I'm very excited about these updates. :)
On October 6, 2019 8:17:15 p.m. PDT, Abhilash Raj <maxking@asynchronous.in> wrote:
Hi All,
I have been trying to work on revamping the documentation site we have at https://docs.mailman3.org. It is on https:// but I am not sure why the http->https redirect doesn't work in Readthedocs. I have set it to "serve always from https".
Anyway, it might not look too different right now, but there are some small re-organizations. I have been learning some new ReST and Sphinx tricks and been trying to cross-reference and link various sections and settings. The docs site shows up Mailman's logo now (I didn't even know we could do that ;-).
There is a place1 for all supported Django settings that Postorius and Hyperkitty have. I am also planning to add some common Django settings that often people have to lookup and is not fun for people from non-python backgrounds. Hopefully, it will make lives easier for administrators.
I have reverted my own stupid decision to use "sudo pip3 install" in the docs to instead use virtualenv. The installation docs are going to grow to be more comprehensive.
I am also working on mailman-web project3, which should simply installation process for all the web components using a single project and provide better guidance on Django's settings file management and howto run manage.py commands.
I have added a
mailman-webcommand, which, for those of you familiar with internal details of Django, is going to be our custom manage.py script. It sets up settings correctly and would hopefully reduce the pain of usingdjango-adminand/or finding out the right path formanage.pyscript. It is still not ready for prime time, but it is usable. Early adopters can play with it if they like!I would really appreciate if people who have tried to manually install Mailman 3 in the past would share their experiences about what they think could be documented better. You can reply here or open an issue2.
The user documentation are going to follow, hopefully soon :)
-- thanks, Abhilash Raj (maxking)
Mailman-users mailing list -- mailman-users@mailman3.org To unsubscribe send an email to mailman-users-leave@mailman3.org https://lists.mailman3.org/mailman3/lists/mailman-users.mailman3.org/
participants (2)
-
Abhilash Raj -
Terri Oda