Hello Aditi!, I am a fellow contributor in this organization under GSoC programme. Great to have you onboard with us.
- Is there any user guide/support page on how to use the mailing list explaining all the features of Postorius and Hyperkitty? For example, how to manage subscription, how to manage lists. what does activity summary means, what does the graph represents, what do the different roles represent, what is the difference between an owner, a moderator and a member. Being new to mailing list, I feel that people may face these issues and having a proper documentation on how to properly utilize the platform will be a great win.
Technically we have each feature defined in "Models" section[1] of the docs under GNU Mailman. That being said, an effective doc page containing the use-cases of these features in postorius and hyperkitty is not there at all. We can definitely add them under the respective doc but I do not know about the priority of this task. Also, what I noticed is that the respective docs of Postorious and Hyperkitty are a little less detailed, we can do some improvements ( like adding these type of use-cases ) and I would love to personally help if some GSoD folks pick it up but again I do not know the priority of this.
One more thing ( this may be nitpicking but I want to clear my point here instead of just keeping it to me ), the docs the name "GNU Mailman" but it then mentions it is technically the "Mailman Core" part and the rest is on separate docs, it took me for a while to get the hang of what it was exactly, Can we bundle this under one "GNU Mailman" and it contains 5 bundles "Suite", "Postorius", "Hyperkitty", "Core", "MailmanClient"? I think this reduces redundancy in the docs and makes them more comprehensible.
Or is the current approach more suitable for reasons that I would definitely like to learn and know. I would definitely like some pointers on this.
During my GSoC days, I failed several issues while setting up the project locally on my machine. It became very difficult to test everything from end to end. And I feel that there should be documentation on how to test the complete application from end to end. For example, I faced difficulty in configuring Mailman to Hyperkitty or how to inject a mail to a thread in Mailman3 and had to go through many discussions to get it running. It took many days to get everything running on the web interface. I feel that we should go through the mail archives of last few years GSoC season and should work on those areas where most of the developers felt difficulty.
Technically the section "Testing mailman 3" of this page[2] will tell you how to run tests and you can see what the tests are under the "tests" folder of the specific repo, ( just see the .rst files ). In case of "facing several issues while setting up locally...", I believe asking in the this mailing list is the best option and if we recognize the problem to be common or something specific, we can write it under a section or at least in some sort of FAQs which are already present here[3]. For the problems which you feel in which "most of the developers felt difficulty," we can definitely look up the archives and make some FAQ out of those problems ( if the FAQ is not there already ), I am up for helping this if anyone of you GSoD folks picks it up.
[1] : https://mailman.readthedocs.io/en/latest/src/mailman/model/docs/model.html [2] : https://mailman.readthedocs.io/en/latest/src/mailman/docs/contribute.html [3] : https://wiki.list.org/DOC/Frequently%20Asked%20Questions
Cheers!