Skip to content

Commit

Permalink
doc: advertise Modules chat room
Browse files Browse the repository at this point in the history
  • Loading branch information
xdelaruelle committed Feb 1, 2025
1 parent 0785fa6 commit 9fa5253
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 25 deletions.
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: "\U00002753 Question"
about: Need some help to understand how to setup or use Modules
labels: question
---
Please use preferably the Modules mailing-list to post question:
To post question, please use preferably either:

> https://sourceforge.net/projects/modules/lists/modules-interest
* the Modules mailing-list: https://sourceforge.net/projects/modules/lists/modules-interest
* the Modules chat room: https://matrix.to/#/#modules:matrix.org
9 changes: 6 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,20 @@ defines its governance model, decision-making process, and long-term vision.
Support questions
-----------------

Please use the `modules-interest mailing list`_ for questions. Do not use the
Please use the `modules-interest mailing list`_
(``[email protected]``) or the `Modules chat room`_
(``#modules:matrix.org``) for questions. Do not use the
issue tracker for this.

.. _modules-interest mailing list: https://sourceforge.net/projects/modules/lists/modules-interest
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org

Asking for new features
-----------------------

Please submit your new feature wishes first to the `modules-interest mailing
list`_. Discussion will help to clarify your needs and sometimes the wanted
feature may already be available.
list`_ or `Modules chat room`_. Discussion will help to clarify your needs and
sometimes the wanted feature may already be available.

Reporting issues
----------------
Expand Down
3 changes: 3 additions & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ Modules 5.6.0 (not yet released)
* Escape square brackets (``[]``) used in values within produced shell code as
these characters may have special meaning on some shells (like *csh*). (fix
issue #565)
* Doc: advertise the `Modules chat room`_ (``#modules:matrix.org``) to discuss
with the community.

.. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org


.. _5.5 release notes:
Expand Down
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,29 +142,32 @@ Community
---------

Modules is an open source project. Questions, discussion, and contributions
are welcome. You can get in contact with the Modules community via the
[modules-interest mailing list][6].
are welcome. You can get in contact with the Modules community via:

* the [modules-interest mailing list][6]
(`[email protected]`)
* the [Modules chat room][7] (`#modules:matrix.org`)

The project is also present on several social media platforms:

* X/Twitter: [@EnvModules][7]
* Mastodon: [@EnvModules@mast.hpc.social][8]
* Bluesky: [@EnvModules.bsky.social][9]
* X/Twitter: [@EnvModules][8]
* Mastodon: [@EnvModules@mast.hpc.social][9]
* Bluesky: [@EnvModules.bsky.social][10]


Contributing
------------

Modules project welcomes contributions of all kinds! Before submitting an
issue or pull request, please take a moment to review our [Contributing
guide][10]. It includes important information about issue reporting, coding
guide][11]. It includes important information about issue reporting, coding
standards, etc.

Please note that Modules project has a [Code of conduct][11]. It ensures a
Please note that Modules project has a [Code of conduct][12]. It ensures a
respectful and inclusive environment for all contributors. By participating in
the Modules community, you agree to abide by its rules.

This project also adheres to a [Technical charter][12], which defines its
This project also adheres to a [Technical charter][13], which defines its
governance model, decision-making process, and long-term vision.


Expand All @@ -174,13 +177,13 @@ Authors
Modules current core developer and maintainer is Xavier Delaruelle,
[email protected]

Many thanks go to the [contributors][13] of the Modules project.
Many thanks go to the [contributors][14] of the Modules project.


Acknowledgments
---------------

We would like to express our gratitude to [CEA][14] for the resources and
We would like to express our gratitude to [CEA][15] for the resources and
funding provided to the project over the recent years.

The following people have notably contributed to Modules and Modules would not
Expand All @@ -203,11 +206,12 @@ be what it is without their contributions:
[4]: https://modules.readthedocs.io/en/stable/NEWS.html
[5]: https://modules.readthedocs.io/en/stable/changes.html
[6]: https://sourceforge.net/projects/modules/lists/modules-interest
[7]: https://x.com/EnvModules
[8]: https://mast.hpc.social/@EnvModules
[9]: https://bsky.app/profile/envmodules.bsky.social
[10]: https://modules.readthedocs.io/en/latest/CONTRIBUTING.html
[11]: CODE_OF_CONDUCT.md
[12]: https://modules.readthedocs.io/en/latest/CHARTER.html
[13]: https://github.com/envmodules/modules/graphs/contributors
[14]: https://www.cea.fr/english
[7]: https://matrix.to/#/#modules:matrix.org
[8]: https://x.com/EnvModules
[9]: https://mast.hpc.social/@EnvModules
[10]: https://bsky.app/profile/envmodules.bsky.social
[11]: https://modules.readthedocs.io/en/latest/CONTRIBUTING.html
[12]: CODE_OF_CONDUCT.md
[13]: https://modules.readthedocs.io/en/latest/CHARTER.html
[14]: https://github.com/envmodules/modules/graphs/contributors
[15]: https://www.cea.fr/english
8 changes: 6 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,11 @@ Community
---------

Modules is an open source project. Questions, discussion, and contributions
are welcome. You can get in contact with the Modules community via the
`modules-interest mailing list`_.
are welcome. You can get in contact with the Modules community via:

* the `modules-interest mailing list`_
(``[email protected]``)
* the `Modules chat room`_ (``#modules:matrix.org``)

The project is also present on several social media platforms:

Expand All @@ -167,6 +170,7 @@ The project is also present on several social media platforms:
* Bluesky: `@EnvModules.bsky.social`_

.. _modules-interest mailing list: https://sourceforge.net/projects/modules/lists/modules-interest
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org
.. _@EnvModules: https://x.com/EnvModules
.. _@[email protected]: https://mast.hpc.social/@EnvModules
.. _@EnvModules.bsky.social: https://bsky.app/profile/envmodules.bsky.social
Expand Down

0 comments on commit 9fa5253

Please sign in to comment.