Commit 5494750d authored by Christoph Groth's avatar Christoph Groth
Browse files

review community page

- Update mailing list subscription information.
- Retire kwant-devel
- Introduce gitlab
parent e98f0063
Pipeline #14525 passed with stage
in 25 seconds
......@@ -11,13 +11,13 @@ Please only contact the authors directly for matters that cannot be discussed
in public on one of the mailing lists.
General mailing list
--------------------
Mailing list
------------
The `kwant-discuss
<https://mailman-mail5.webfaction.com/listinfo/kwant-discuss>`_ mailing list is
the main public communication platform for anything related to Kwant: questions,
bug reports, discussions, and announcements. You can use it in various ways:
The kwant-discuss mailing list is the main public communication platform for
anything related to Kwant: questions, discussions, development, and
announcements. (Bug reports may be also sent, but the preferred way is
described further below on this page.) You can use it in various ways:
- .. raw:: html
......@@ -31,18 +31,13 @@ bug reports, discussions, and announcements. You can use it in various ways:
</div>
</form>
- .. raw:: html
<form class="form-inline" method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-discuss">
<div class="input-group col-md-8">
<input type="text" class="form-control" placeholder="Your email address" name="email" size=25 onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" name="email-button" value="Subscribe to kwant-discuss" />
</span>
</div>
</form>
… and receive new messages with regular email. (To unsubscribe, use the `kwant-discuss options page <https://mailman-mail5.webfaction.com/options/kwant-discuss>`_.)
- to subscribe and receive new messages by email: either use the form on the
`kwant-discuss info page
<https://mailman-mail5.webfaction.com/listinfo/kwant-discuss>`_ or simply send
a message to kwant-discuss-join@kwant-project.org. (The subject and content
are ignored and may be empty.) To unsubscribe, either use the form at the
bottom of the info page, or send any message to
kwant-discuss-leave@kwant-project.org.
- You may follow the list through a web interface that also provides a RSS
feed: `kwant-discuss on Mail-archive
......@@ -51,70 +46,32 @@ bug reports, discussions, and announcements. You can use it in various ways:
- Whether you are subscribed or not, you may post on the list simply by sending
email to kwant-discuss@kwant-project.org.
- Please do not hesitate to join the discussion! It’s easy to reply to a
- Please do not hesitate to join the discussion. It’s easy to reply to a
posting even if you are not subscribed (or receiving digests): (1) open the
article in the web interface, (2) click on the button “Reply via email to” at
the bottom of the page, (3) add the above list address under "CC".
Development chat
----------------
article in the mail-archive web interface, (2) click on the button “Reply via
email to” at the bottom of the page, (3) add the above list address under
"CC".
The Kwant developer chat is accessible to the community via `Gitter <https://gitter.im/kwant-project/Lobby>`_.
Come say hi if you would like to get involved with developing Kwant! For longer development discussions
we prefer posting to the development mailing list. This is a place for technical discussions about changes
to Kwant. For bug reports please use the kwant-discuss mailing list.
The `Kwant development mailing list
<https://mailman-mail5.webfaction.com/listinfo/kwant-devel>`_ has been retired
in 2019. Please use the main list instead, or the other communication channels
listed below (chat and gitlab). The archives of kwant-devel remain searchable:
Development mailing list
------------------------
.. raw:: html
Those who are interested the development of Kwant are invited to subscribe to
the `kwant-devel <https://mailman-mail5.webfaction.com/listinfo/kwant-devel>`_
mailing list. This is the place for technical discussions about changes to
Kwant. Please do not send bug reports to this list but rather to kwant-discuss.
<form class="form-inline" method="get" action="https://www.mail-archive.com/search">
<div class="input-group col-md-8">
<input type="text" class="form-control" placeholder="Search query" size=25 name="q">
<input type="hidden" name="l" value="kwant-devel@kwant-project.org">
<span class="input-group-btn">
<input class="btn btn-default" type="submit" value="Search kwant-devel">
</span>
</div>
</form>
Kwant-devel works in the same way as kwant-discuss:
- .. raw:: html
<form class="form-inline" method="get" action="https://www.mail-archive.com/search">
<div class="input-group col-md-8">
<input type="text" class="form-control" placeholder="Search query" size=25 name="q">
<input type="hidden" name="l" value="kwant-devel@kwant-project.org">
<span class="input-group-btn">
<input class="btn btn-default" type="submit" value="Search kwant-devel">
</span>
</div>
</form>
- .. raw:: html
<form class="form-inline" method=post action="https://mailman-mail5.webfaction.com/subscribe/kwant-devel">
<div class="input-group col-md-8">
<input type="text" class="form-control" placeholder="Your email address" name="email" size=25 onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" name="email-button" value="Subscribe to kwant-devel" />
</span>
</div>
</form>
(To unsubscribe, use the `kwant-devel options page <https://mailman-mail5.webfaction.com/options/kwant-devel>`_.)
- You may follow the list through a web interface that also provides a RSS
feed: `kwant-devel on Mail-archive
<https://www.mail-archive.com/kwant-devel@kwant-project.org/>`_.
- Whether you are subscribed or not, you may post on the list simply by sending
email to kwant-devel@kwant-project.org.
- It’s easy to reply to a posting even if you are not subscribed (or receiving
digests): (1) open the article in the web interface, (2) click on the button
“Reply via email to” at the bottom of the page, (3) add the above list address
under "CC".
Announcements (low-volume)
Announcements mailing list
--------------------------
This read-only list is reserved for important announcements like new releases of
......@@ -122,18 +79,31 @@ Kwant. Only a few messages will be sent per year. These announcements will be
- View archives: `kwant-announce on Mail-archive <https://www.mail-archive.com/kwant-announce@kwant-project.org/>`_. Mail-archive provides RSS feeds.
- .. raw:: html
- There are two ways to subscribe: either use the form on the `kwant-announce
info page <https://mailman-mail5.webfaction.com/listinfo/kwant-announce>`_ or
simply send any message to kwant-announce-join@kwant-project.org. (The subject
and content are ignored and may be empty.) To unsubscribe, either use the
form at the bottom of the info page, or send any message to
kwant-announce-leave@kwant-project.org.
<form method=post class="form-inline" action="https://mailman-mail5.webfaction.com/subscribe/kwant-announce">
<div class="input-group col-md-8">
<input type="text" class="form-control" placeholder="Your email address" name="email" size=25 onblur="if (this.value == '') {this.value='Your email address'}" onfocus="if (this.value == 'Your email address') {this.value=''}" />
<span class="input-group-btn">
<input class="btn btn-default" type="submit" name="email-button" value="Subscribe to the announcements" />
</span>
</div>
</form>
(To unsubscribe, use the `kwant-announce options page <https://mailman-mail5.webfaction.com/options/kwant-announce>`_.)
Development chat
----------------
The Kwant developer chat is accessible to the community via `Gitter
<https://gitter.im/kwant-project/Lobby>`_. Come say hi if you would like to get
involved with developing Kwant!
Gitlab instance
---------------
The Kwant project runs a `gitlab instance <https://gitlab.kwant-project.org/>`_
that hosts the `main Kwant code repository
<https://gitlab.kwant-project.org/kwant/kwant>`_ as well as the `repositories of
related projects <https://gitlab.kwant-project.org/kwant>`_. The gitlab
instance is used for reporting bugs (see next section) and `development
</contribute.html>`_
Reporting bugs
......
......@@ -18,9 +18,7 @@ categorized with labels, so that it is possible to view `all the “easy” issu
<https://gitlab.kwant-project.org/kwant/kwant/issues?label_name=difficulty%3A+easy>`_
for example.
Please do feel free to enter new issues yourself. If you are unsure about
some aspect It may be a good idea to discuss your idea on the development
mailing list kwant-devel@kwant-project.org before filing an issue.
Please do feel free to enter new issues yourself. If you are unsure about some aspect It may be a good idea to discuss your idea on the mailing list kwant-discuss@kwant-project.org before filing an issue.
If you already have some code that extends Kwant in a useful way, please
consider sharing it. If your extension fits well with Kwant and is of wide
......@@ -124,18 +122,18 @@ Now you can push your topic branch to your repository::
This will make your branch appear in GitLab. Now you can let us know about
your branch by `creating a merge request in GitLab
<https://gitlab.kwant-project.org/help/workflow/forking_workflow.md>`_ or by
sending a message to kwant-devel@kwant-project.org.
sending a message to kwant-discuss@kwant-project.org.
Method 2: Sending patches to the development mailing list
.........................................................
Method 2: Sending patches to the mailing list
.............................................
Run the command ::
git format-patch origin/master
This will create a “patch” file for each commit on your branch. Now simply
send these patches as email attachments to kwant-devel@kwant-project.org,
send these patches as email attachments to kwant-discuss@kwant-project.org,
together with an explanation of your idea. You do not have to be subscribed
to the mailing list.
......
......@@ -6,7 +6,7 @@ Going beyond the core package, there are several tools that extend Kwant in usef
You can check these out below.
If you have some re-usable code that you think would be useful to the wider Kwant community,
post to the `Kwant development mailing list <mailto:kwant-devel@kwant-project.org>`_ with a
post to the `Kwant development mailing list <mailto:kwant-discuss@kwant-project.org>`_ with a
link to the code and a couple of sentences describing it, and we'll add it to this page.
......
Markdown is supported
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