Skip to content

Commit

Permalink
Updated remaining references to mailing lists
Browse files Browse the repository at this point in the history
Defined hyperlinks for the mailing lists and archives so that they can
be used conveniently in all .rst files

Closes #4651

Closes #4651
  • Loading branch information
ckutzne authored and mabraham committed Nov 14, 2022
1 parent 49fac8a commit 15aeadf
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 21 deletions.
2 changes: 1 addition & 1 deletion admin/InstallInfo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ GROMACS is a versatile and high-performance toolkit for molecular simulations, a

The precompiled binary distributions come with threads support for efficient parallelization on multi-core workstations, but if you want to use large-scale MPI parallelization you will need to build from source on the target system due to MPI library compatibility issues.

If you have problems, you can find lots of documentation at http://www.gromacs.org. You can also post to the mailing lists, but considering these are very high volume it might be a good idea to use the archive search functionality on the website first.
If you have problems, you can find lots of documentation at http://www.gromacs.org. You can also post to the discussion forums, but considering these are very high volume it might be a good idea to use the archive search functionality on the website first.

2 changes: 1 addition & 1 deletion cmake/gmxCPackUtilities.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ function (gmx_cpack_write_config)
# Set basic package information.
set(CPACK_PACKAGE_NAME "gromacs")
set(CPACK_PACKAGE_VENDOR "gromacs.org")
set(CPACK_PACKAGE_CONTACT "gmx-users@gromacs.org")
set(CPACK_PACKAGE_CONTACT "https://gromacs.bioexcel.eu/c/gromacs-user-forum/5")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY
"GROMACS - a toolkit for high-performance molecular simulation")
# Set version info.
Expand Down
4 changes: 4 additions & 0 deletions docs/conf.cmakein.py
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,10 @@
.. |gmx-source-package-http| replace:: As https https://ftp.gromacs.org/gromacs/gromacs-{gmx_version_string}.tar.gz
.. |gmx-regressiontests-package| replace:: https://ftp.gromacs.org/regressiontests/regressiontests-{regressiontest_version}.tar.gz
.. _up-to-date installation instructions: https://manual.gromacs.org/documentation/current/install-guide/index.html
.. _developer discussion forum: https://gromacs.bioexcel.eu/c/gromacs-developers/10
.. _user discussion forum: https://gromacs.bioexcel.eu/c/gromacs-user-forum/5
.. _gmx-developers mailing list archive: https://mailman-1.sys.kth.se/pipermail/gromacs.org_gmx-developers
.. _gmx-users mailing list archive: https://mailman-1.sys.kth.se/pipermail/gromacs.org_gmx-users
.. _CUDA: https://developer.nvidia.com/cuda-zone
.. _OpenCL: https://www.khronos.org/opencl/
.. _SYCL: https://www.khronos.org/sycl/
Expand Down
2 changes: 1 addition & 1 deletion docs/dev-manual/change-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ If the proposed change still seems important and the next steps are unclear,
contributors with stale issues *are encouraged...*

- to contact existing reviewers (or potential reviewers),
- to participate in the developer discussion forum, and
- to participate in the `developer discussion forum`_, and
- to attend the biweekly teleconference to coordinate.

If the future of the merge request has not become clear within a month
Expand Down
5 changes: 1 addition & 4 deletions docs/dev-manual/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ that. However, the subsequent code maintenance is time-consuming and
requires both "up front" and long-term commitment from you, and others
who might not share your particular scientific enthusiasm. Please read
this page first, and at least post on the `developer discussion forum`_.
Looking through the `developer mailing list`_ archives might also be
Looking through the `gmx-developers mailing list archive`_ might also be
helpful. Sometimes we'll be able to save you a lot of time even at the
planning stage!

Expand Down Expand Up @@ -166,9 +166,6 @@ please feel free to contact us through the `developer discussion forum`_.
If your code is of interest to the wider |Gromacs| community, we will be happy to assist you
in the process of including it in the main source tree.

.. _developer discussion forum: https://gromacs.bioexcel.eu/c/gromacs-developers/10
.. _developer mailing list: https://mailman-1.sys.kth.se/pipermail/gromacs.org_gmx-developers/

Removing functionality
----------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-manual/reportstyle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,4 @@ as the issue is processed.
.. 5. If you set the priority to "high" as a user, we assume this means you will also prioritize it yourself and provide close to instant feedback and/or help with testing. If you are a developer, setting the priority to "high" means you are working on fixing this bug yourself. In other words: Please do not set the priority to "high" just to get somebody else to fix it faster.
.. At some point it might be necessary to have more files (including those large scripts) to debug the problem, but you are much more likely to get help if developers do not have to search for files in several different places, read up on a number of threads on the mailing list, follow a long discussion about what you want to do, and then decipher scripts to understand what happened.
.. At some point it might be necessary to have more files (including those large scripts) to debug the problem, but you are much more likely to get help if developers do not have to search for files in several different places, read up on a number of threads in the discussion forums, follow a long discussion about what you want to do, and then decipher scripts to understand what happened.
4 changes: 2 additions & 2 deletions docs/how-to/special.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Exotic Species
So, you want to simulate a protein/nucleic acid system, but it binds various exotic metal
ions (ruthenium?), or there is an iron-sulfur cluster essential for its functionality, or similar.
But, (unfortunately?) there aren't parameters available for these in the force field you want
to use. What should you do? You shoot an e-mail to the |Gromacs| users emailing list, and get referred to the FAQs.
to use. What should you do? You shoot an e-mail to the |Gromacs| `user discussion forum`_, and get referred to the FAQs.

If you really insist on simulating these in molecular dynamics, you'll need to obtain parameters
for them, either from the literature, or by doing your own parametrization. But before doing so,
Expand Down Expand Up @@ -173,7 +173,7 @@ Carbon Nanotube
Robert Johnson's Tips
^^^^^^^^^^^^^^^^^^^^^

Taken from Robert Johnson's posts on the gmx-users mailing list.
Taken from Robert Johnson's posts on the `gmx-users mailing list archive`_.

* Be absolutely sure that the "terminal" carbon atoms are sharing a bond in the topology file.
* Use ``periodic_molecules = yes`` in your :ref:`mdp` file for input in :ref:`gmx grompp`.
Expand Down
20 changes: 11 additions & 9 deletions docs/install-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ If there is a serious problem detected at this stage, then you will see
a fatal error and some suggestions for how to overcome it. If you are
not sure how to deal with that, please start by searching on the web
(most computer problems already have known solutions!) and then
consult the gmx-users mailing list. There are also informational
consult the `user discussion forum`_. There are also informational
warnings that you might like to take on board or not. Piping the
output of ``cmake`` through ``less`` or ``tee`` can be
useful, too.
Expand Down Expand Up @@ -626,7 +626,7 @@ an architecture with SIMD support to which |Gromacs| has not yet been
ported, you may wish to try this option instead of the default
``GMX_SIMD=None``, as it can often out-perform this when the
auto-vectorization in your compiler does a good job. And post on the
|Gromacs| mailing lists, because |Gromacs| can probably be ported for new
|Gromacs| `user discussion forum`_, because |Gromacs| can probably be ported for new
SIMD architectures in a few days.

CMake advanced options
Expand Down Expand Up @@ -1129,7 +1129,7 @@ It is expected that this will always complete successfully, and
give few or no warnings. The CMake-time tests |Gromacs| makes on the settings
you choose are pretty extensive, but there are probably a few cases we
have not thought of yet. Search the web first for solutions to
problems, but if you need help, ask on gmx-users, being sure to
problems, but if you need help, ask on the `user discussion forum`_, being sure to
provide as much information as possible about what you did, the system
you are building on, and what went wrong. This may mean scrolling back
a long way through the output of ``make`` to find the first error
Expand Down Expand Up @@ -1286,21 +1286,23 @@ follow these steps to find the solution:
1. Read the installation instructions again, taking note that you
have followed each and every step correctly.

2. Search the |Gromacs| webpage_ and users emailing list for information
2. Search the |Gromacs| webpage_ and `user discussion forum`_ for information
on the error. Adding
``site:https://mailman-1.sys.kth.se/pipermail/gromacs.org_gmx-users``
``site:https://gromacs.bioexcel.eu/c/gromacs-user-forum/5``
to a Google search may help filter better results.
It is also a good idea to check the `gmx-users mailing list archive`_ at
``https://mailman-1.sys.kth.se/pipermail/gromacs.org_gmx-users``

3. Search the internet using a search engine such as Google.

4. Post to the |Gromacs| users emailing list gmx-users for
assistance. Be sure to give a full description of what you have
4. Ask for assistance on the |Gromacs| `user discussion forum`_.
Be sure to give a full description of what you have
done and why you think it did not work. Give details about the
system on which you are installing. Copy and paste your command
system on which you are installing. Copy and paste your command
line and as much of the output as you think might be relevant -
certainly from the first indication of a problem. In particular,
please try to include at least the header from the mdrun logfile,
and preferably the entire file. People who might volunteer to help
and preferably the entire file. People who might volunteer to help
you do not have time to ask you interactive detailed follow-up
questions, so you will get an answer faster if you provide as much
information as you think could possibly help. High quality bug
Expand Down
5 changes: 3 additions & 2 deletions docs/reference-manual/preface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ to lack of time of the contributors -- our first priority is to improve
the software. It is worked on continuously,
which in some cases might mean the information is not entirely correct.

Comments on form and content are welcome, please send them to one of
the mailing lists (see our `webpage`_ or this section on
Comments on form and content are welcome, please send them to the
`user discussion forum`_ or the `developer discussion forum`_
(see our `webpage`_ or this section on
how to :ref:`contribute <gmx-contribute>`), or open an issue
on our `issue tracker`_. Corrections can also be made in the |Gromacs| git
source repository and uploaded to the |Gromacs| `GitLab`_.
Expand Down

0 comments on commit 15aeadf

Please sign in to comment.