Hi All,
Mailman 3 is now setup for continuous internationalization. We are using Hosted Weblate[1], which is the hosted service for the Weblate project[2]. It is actually quite nice and I've been learning how to properly document a Django project from it's documentation.
Which brings me to it's documentation. Weblate has great documentation for translators[2]. The UI pretty simple and should be easy to navigate around.
We have setup the workflow in a way that each commit in Gitlab generates a webhook and updates Weblate. Weblate is then able to pull all the changes in real time. To pull translations back into Gitlab, I have a custom script running every night that pulls translations (as commits) and generates pull requests against the upstream repos.
Weblate has the ability to automatically push the translations back, but for security reasons, I didn't want to give a 3rd party service direct push access to our repos. I've been working on a Patch to Weblate[3], which would allow it to send translations as Merge Requests (as compared to direct-push). After it is merged and deployed at hosted.weblate.org, I hope I can retire my custom script.
We have setup the following projects:
- Mailman Core (https://hosted.weblate.org/projects/gnu-mailman/mailman/)
- Postorius* (https://hosted.weblate.org/projects/gnu-mailman/translations/)
- Hyperkitty (https://hosted.weblate.org/projects/gnu-mailman/hyperkitty/)
- Django-mailman3 (https://hosted.weblate.org/projects/gnu-mailman/django-mailman3/)
There should be empty .po files generated for most languages supported by Django and Mailman Core. If there are any questions or bugs related to source strings, please send out an email to mailman-developers(a)python.org.
The current translation %age is pretty low, hopefully we'll be ale to get it close to Mailman 2 sometime soon :)
[1]: https://hosted.weblate.org/projects/gnu-mailman/
[2]: https://docs.weblate.org/en/latest/user/translating.html
[3]: https://github.com/WeblateOrg/weblate/pull/3024
[*] Yeah, the URL for Postorius is a bit weird, because it was called "translations" before. At the time, I didn't know the difference between a project and a translation component in Weblate terminologies. And they don't give out permissions to change the URL, so we're maybe stuck with it.
--
thanks,
Abhilash Raj (maxking)
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 place[1] 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 project[3], 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 issue[2].
The user documentation are going to follow, hopefully soon :)
[1]: https://docs.mailman3.org/en/latest/config-web.html#configure-postorius-hyp…
[2]: https://gitlab.com/mailman/mailman-suite-doc/issues
[3]: https://gitlab.com/mailman/mailman-web
--
thanks,
Abhilash Raj (maxking)
