Skip to content

Commit

Permalink
Replace mailing list with GitHub Discussions (#349)
Browse files Browse the repository at this point in the history
  • Loading branch information
RMeli authored Dec 23, 2023
1 parent ca945ec commit 2d837e8
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 25 deletions.
15 changes: 6 additions & 9 deletions .github/ISSUE_TEMPLATE/questions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
name: Questions
about: If you want to ask a question please use the mailing list!
title: ''
labels: ''
assignees: ''
about: If you want to ask a question please use GitHub Discussions!

---

Expand All @@ -12,15 +9,15 @@ If you have a **QUESTION** such as
- how to use MDAnalysis in general
- how to accomplish something specific,
- what output means
- ... or similar questions related to USING MDAnalysis
- ... or similar questions related to *USING* MDAnalysis

then please *ask this question on the user mailing list*
then please *ask this question on GitHub Discussions*

https://groups.google.com/forum/#!forum/mdnalysis-discussion
https://github.com/MDAnalysis/mdanalysis/discussions

The issue tracker is meant for DEFECTS ("BUGS"), new FEATURES, and decisions on the direction of the user guide. In order to keep the volume of work on the issue tracker manageable for our volunteer developers, we will **immediately close issues that are better answered on the user mailing list.**
The issue tracker is meant for DEFECTS ("BUGS"), new FEATURES, and decisions on the API. In order to keep the volume of work on the issue tracker manageable for our volunteer developers, we will migrate issues with questions to [GitHub Discussions](https://github.com/MDAnalysis/mdanalysis/discussions).

We really appreciate you as a user getting in touch with us --- no matter what you want to discuss. But we need your help keeping the amount of work manageable so please use the mailing list for questions and the issue tracker for code-related issues.
We really appreciate you getting in touch with us --- no matter what you want to discuss. But we need your help keeping the amount of work manageable so please use [GitHub Discussions](https://github.com/MDAnalysis/mdanalysis/discussions) for questions and the issue tracker for code-related issues.

Thank you!

Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Contributions can take many forms, such as:
* **new features** in the code
* improvements and additions to **documentation** (including typo fixes)
* improvements to the **build systems**
* **questions** or **discussions** on the `mdnalysis-discussion`_ mailing list
* **questions** or **discussions** on `GitHub Discussions`_

The MDAnalysis community subscribes to a `Code of Conduct`_ that all community
members agree and adhere to --- please read it.
Expand Down
6 changes: 3 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ MDAnalysis welcomes all contributions from its users. There are many ways you ca
Communications
--------------

Questions and discussions about MDAnalysis take place on the mailing lists and this repository’s `Issue Tracker`_. Anybody is welcome to join these conversations. Please ask questions about the usage of MDAnalysis on the `mdnalysis-discussion`_ mailing list, and report problems on the `Issue Tracker`_.
Questions and discussions about MDAnalysis take place on `GitHub Discussions`_ and this repository’s `Issue Tracker`_. Anybody is welcome to join these conversations. Please ask questions about the usage of MDAnalysis on the `mdnalysis-discussion`_ mailing list, and report problems on the `Issue Tracker`_.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.

.. _`mdnalysis-discussion`:
https://groups.google.com/group/mdnalysis-discussion
.. _`GitHub Discussions`:
https://github.com/MDAnalysis/mdanalysis/discussions
.. _`Code of Conduct`: https://www.mdanalysis.org/pages/conduct/
.. _`Issue Tracker`: https://github.com/MDAnalysis/mdanalysis/issues

Expand Down
6 changes: 3 additions & 3 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ The tests are distributed separately from the main package.


If you encounter any issues following these instructions, please
ask for help on the `user mailing list`_.
ask for help on `GitHub Discussions (Installation)`_.

.. _`user mailing list`: https://groups.google.com/forum/#!forum/mdnalysis-discussion
.. _`GitHub Discussions (Installation)`: https://github.com/MDAnalysis/mdanalysis/discussions/categories/installation

conda
=====
Expand Down Expand Up @@ -131,7 +131,7 @@ The tests rely on the `pytest` and `numpy` packages, which must also be installe
pytest --disable-pytest-warnings --pyargs MDAnalysisTests
All tests should pass (i.e. no FAIL, ERROR); SKIPPED or XFAIL are ok. If anything fails or gives an error,
`ask on the user mailing list <http://users.mdanalysis.org/>`_ or `raise an issue <https://github.com/MDAnalysis/mdanalysis/issues>`_.
`ask on GitHub Discussions <https://github.com/MDAnalysis/mdanalysis/discussions>`_ or `raise an issue <https://github.com/MDAnalysis/mdanalysis/issues>`_.

Testing MDAnalysis can take a while, as there are quite a few tests.
The plugin `pytest-xdist <https://github.com/pytest-dev/pytest-xdist>`_ can be used to run tests in parallel.
Expand Down
4 changes: 2 additions & 2 deletions doc/source/module_imports.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ Any module from the standard library can be used, as well as the following nonst

because these packages are always installed.

If you must depend on a new external package, first discuss its use on the `developer mailing list`_ or as part of the issue/pull request.
If you must depend on a new external package, first discuss its use on `GitHub Discussions (Development)`_ or as part of the issue/pull request.

.. _`developer mailing list`: https://groups.google.com/forum/#!forum/mdnalysis-devel
.. _`GitHub Discussions (Development)`: https://github.com/MDAnalysis/mdanalysis/discussions/categories/developement


.. _core-modules:
Expand Down
10 changes: 5 additions & 5 deletions doc/source/preparing_releases_and_hotfixes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Typical workflow for preparing a release
Summary of tasks
----------------

* Declare a `feature freeze` on `develop` via discord and/or the developer mailing list
* Declare a `feature freeze` on `develop` via discord and/or GitHub Discussions (Announcement)
* Finalize the ``CHANGELOG`` file with the date of release
* Increment the version across ``MDAnalysis`` and ``MDAnalysisTests`` (4 places)
* `Merge` changes into `develop`
Expand All @@ -67,7 +67,7 @@ Summary of tasks
Getting the develop branch ready for a release
----------------------------------------------

#. Declare feature freeze on ``develop`` via `discord` and the `developer mailing list`_
#. Declare feature freeze on ``develop`` via `discord` and `GitHub Discussions (Anouncement)`_

#. Create a pre-release feature branch from ``develop``

Expand Down Expand Up @@ -204,7 +204,7 @@ For now, the UserGuide is released at the same time as the core library. If it's
Create a blog post outlining the release
----------------------------------------

Create a blog post outlining the release notes and publicize it on the mailing list / discord / twitter/ etc...!
Create a blog post outlining the release notes and publicize it on GitHub Discussions / discord / twitter/ etc...!


Increment develop branch files ready for the next version
Expand All @@ -216,7 +216,7 @@ Once the release is completed you can go ahead and update the ``develop`` branch

#. Update the CHANGELOG with a new entry for the next release.

#. Once these changes are merged into the ``develop`` branch, message the developers on discord and the mailing list letting them know that the feature freeze is over.
#. Once these changes are merged into the ``develop`` branch, message the developers on discord and GitHub Discussions letting them know that the feature freeze is over.


Clean up old developer builds of the documentation
Expand All @@ -227,7 +227,7 @@ Whilst new docs are automatically deployed on a release, old developer builds (a
While this is still a manual procedure, you should also edit `versions.json` to remove the old dev links.


.. _`developer mailing list`: https://groups.google.com/forum/#!forum/mdnalysis-devel
.. _`GitHub Discussions (Announcement)`: https://groups.google.com/forum/#!forum/mdnalysis-devel
.. _`deploy github action`: https://github.com/MDAnalysis/mdanalysis/tree/develop/.github/workflows/deploy.yaml
.. _`MDAnalysis feedstock`: https://github.com/conda-forge/mdanalysis-feedstock
.. _`MDAnalysisTests feedstock`: https://github.com/conda-forge/mdanalysistests-feedstock
Expand Down
4 changes: 2 additions & 2 deletions doc/source/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It is recommended that you run the tests from the ``mdanalysis/testsuite/MDAnaly
cd testsuite/MDAnalysisTests
pytest --disable-pytest-warnings
All tests should pass: no **FAIL** or **ERROR** cases should be triggered; *SKIPPED* or *XFAIL* are ok. For anything that fails or gives an error, ask on the `mdnalysis-discussion`_ mailing list or raise an issue on the `Issue Tracker <https://github.com/MDAnalysis/mdanalysis/issues>`_.
All tests should pass: no **FAIL** or **ERROR** cases should be triggered; *SKIPPED* or *XFAIL* are ok. For anything that fails or gives an error, ask on `GitHub Discussions`_ or raise an issue on the `Issue Tracker <https://github.com/MDAnalysis/mdanalysis/issues>`_.

We use the ``--disable-pytest-warnings`` when the whole testsuite is running, as pytest raises a lot of false positives when we warn users about missing topology attributes. When running single tests or only single modules, consider running the tests *with* warnings enabled (i.e. without ``--disable-pytest-warnings``). This allows you to see if you trigger any un-caught deprecation warnings or other warnings in libraries we use.

Expand Down Expand Up @@ -389,4 +389,4 @@ If possible, re-use the existing data files in MDAnalysis for tests; this helps
#. Make sure your new files are picked up by the pattern-matching in ``testsuite/setup.py`` (in the ``package_data`` dictionary).


.. _`mdnalysis-discussion`: http://groups.google.com/group/mdnalysis-discussion
.. _`GitHub Discussions`: https://github.com/MDAnalysis/mdanalysis/discussions

0 comments on commit 2d837e8

Please sign in to comment.