Commit 75522d22 authored by Christoph Groth's avatar Christoph Groth
Browse files

rewrite mailing list sections of community page

parent 34ecb317
Pipeline #36823 passed with stage
in 23 seconds
......@@ -6,47 +6,58 @@ Everybody is welcome to participate in the community
by asking and replying to questions, reporting bugs, providing suggestions,
and `contributing to the code and documentation </contribute.html>`_.
The Kwant community uses three public communication channels:
the mailing list for generic discussions, questions, and announcements,
the gitlab instance for development discussions and reporting bugs,
and the chat for real-time discussions related to development.
A list of `Kwant authors </authors>`_ is included in the documentation.
Please only contact the authors directly for matters that cannot be discussed in public on one of the mailing lists.
Please contact the authors directly only for matters that cannot be discussed on the public channels.
Mailing list
------------
The kwant-discuss mailing list is the main public communication platform for topics related to Kwant:
questions, discussions, development, and announcements.
- The simplest way to send a message to the list is to write to
kwant-discuss@python.org.
If you are not subscribed, your message will be held for moderation.
When asking a question,
please follow the usual `recommendations for asking good questions <https://stackoverflow.com/help/how-to-ask>`_.
In particular, please make sure that the topic has not been covered already by searching:
.. raw:: html
<form class="form-inline" method="get" action="https://mail.python.org/archives/search">
<div class="input-group col-md-8">
<input type="hidden" name="mlist" value="kwant-discuss@python.org">
<input type="text" class="form-control" placeholder="Search query" size=25 name="q">
<span class="input-group-btn">
<input class="btn btn-default" type="submit" value="Search kwant-discuss">
</span>
</div>
</form>
- You may subscribe to receive all posts to the list by email.
(The volume is seldom more than a dozen messages per week.)
Subscription is done either through a form on the
`kwant-discuss info page
<https://mail.python.org/mailman3/lists/kwant-discuss.python.org/>`_
or simply by sending anything (even an empty message) to
kwant-discuss-join@python.org.
To unsubscribe, either use the info page,
or send any message to kwant-discuss-leave@python.org.
- The list can be also used as a web forum: `kwant-discuss web interface
<https://mail.python.org/archives/list/kwant-discuss@python.org/>`_.
The kwant-discuss list may be used both as a web forum and as an email based list.
The `kwant-discuss web interface <https://mail.python.org/archives/list/kwant-discuss@python.org/>`_
allows to follow discussions and search the complete archives.
To start a new discussion thread, you may either use the web interface
(sign-in required)
or email directly to
kwant-discuss@python.org.
In order to avoid spam,
messages of unsubscribed participants are held for moderation.
Similarly, replying to posts is possible either by email
(if you received the post to which you want reply by email),
or in the web interface: note the “reply” button under each message.
For signed-in users it allows to compose a reply within the web interface,
for non-signed-in users a reply by email is triggered.
You may subscribe to receive all posts to the list by email.
(The volume is seldom more than a dozen messages per week.)
Subscription is done either through the
`kwant-discuss info page
<https://mail.python.org/mailman3/lists/kwant-discuss.python.org/>`_
or by sending any message to
kwant-discuss-join@python.org.
(The subject and content are ignored and may be empty.)
To unsubscribe, either use the info page,
or send any message to kwant-discuss-leave@python.org.
List etiquette :
- When asking questions,
`help others to help yourself <https://stackoverflow.com/help/how-to-ask>`_.
In particular, use the search function before posting.
- Make sure that your post is reasonably formatted.
In particular, do not reply to digests (use the forum reply instead).
When replying, please avoid quoting the complete original message.
Instead, consider
`bottom-posting <https://en.wikipedia.org/wiki/Posting_style#Bottom-posting>`_.
Announcements mailing list
......@@ -58,13 +69,13 @@ These announcements are also posted on the main mailing list,
so there is no need to subscribe to both lists.
We recommend every user of Kwant to subscribe at least to this list in order to stay informed about new developments.
- Consult the `kwant-announce archives on the web <https://mail.python.org/archives/list/kwant-announce@python.org/latest>`_.
The `kwant-announce archives <https://mail.python.org/archives/list/kwant-announce@python.org/>`_
are available on the web.
- There are two ways to subscribe:
either use the form on the `kwant-announce info page <https://mail.python.org/mailman3/lists/kwant-announce.python.org/>`_
or simply send any message to kwant-announce-join@python.org.
(The subject and content are ignored and may be empty.)
To unsubscribe, either use the the info page, or send any message to kwant-announce-leave@python.org.
To subscribe, either use the form on the `kwant-announce info page <https://mail.python.org/mailman3/lists/kwant-announce.python.org/>`_
or simply send any message to kwant-announce-join@python.org.
(The subject and content are ignored and may be empty.)
To unsubscribe, either use the info page, or send any message to kwant-announce-leave@python.org.
Development chat
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment