Skip to content

Commit 9fa5253

Browse files
committed
doc: advertise Modules chat room
1 parent 0785fa6 commit 9fa5253

File tree

5 files changed

+40
-25
lines changed

5 files changed

+40
-25
lines changed

.github/ISSUE_TEMPLATE/question.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ name: "\U00002753 Question"
33
about: Need some help to understand how to setup or use Modules
44
labels: question
55
---
6-
Please use preferably the Modules mailing-list to post question:
6+
To post question, please use preferably either:
77

8-
> https://sourceforge.net/projects/modules/lists/modules-interest
8+
* the Modules mailing-list: https://sourceforge.net/projects/modules/lists/modules-interest
9+
* the Modules chat room: https://matrix.to/#/#modules:matrix.org

CONTRIBUTING.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,20 @@ defines its governance model, decision-making process, and long-term vision.
1919
Support questions
2020
-----------------
2121

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

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

2730
Asking for new features
2831
-----------------------
2932

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

3437
Reporting issues
3538
----------------

NEWS.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,11 @@ Modules 5.6.0 (not yet released)
2929
* Escape square brackets (``[]``) used in values within produced shell code as
3030
these characters may have special meaning on some shells (like *csh*). (fix
3131
issue #565)
32+
* Doc: advertise the `Modules chat room`_ (``#modules:matrix.org``) to discuss
33+
with the community.
3234

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

3538

3639
.. _5.5 release notes:

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -142,29 +142,32 @@ Community
142142
---------
143143

144144
Modules is an open source project. Questions, discussion, and contributions
145-
are welcome. You can get in contact with the Modules community via the
146-
[modules-interest mailing list][6].
145+
are welcome. You can get in contact with the Modules community via:
146+
147+
* the [modules-interest mailing list][6]
148+
149+
* the [Modules chat room][7] (`#modules:matrix.org`)
147150

148151
The project is also present on several social media platforms:
149152

150-
* X/Twitter: [@EnvModules][7]
151-
* Mastodon: [@EnvModules@mast.hpc.social][8]
152-
* Bluesky: [@EnvModules.bsky.social][9]
153+
* X/Twitter: [@EnvModules][8]
154+
* Mastodon: [@EnvModules@mast.hpc.social][9]
155+
* Bluesky: [@EnvModules.bsky.social][10]
153156

154157

155158
Contributing
156159
------------
157160

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

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

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

170173

@@ -174,13 +177,13 @@ Authors
174177
Modules current core developer and maintainer is Xavier Delaruelle,
175178
176179

177-
Many thanks go to the [contributors][13] of the Modules project.
180+
Many thanks go to the [contributors][14] of the Modules project.
178181

179182

180183
Acknowledgments
181184
---------------
182185

183-
We would like to express our gratitude to [CEA][14] for the resources and
186+
We would like to express our gratitude to [CEA][15] for the resources and
184187
funding provided to the project over the recent years.
185188

186189
The following people have notably contributed to Modules and Modules would not
@@ -203,11 +206,12 @@ be what it is without their contributions:
203206
[4]: https://modules.readthedocs.io/en/stable/NEWS.html
204207
[5]: https://modules.readthedocs.io/en/stable/changes.html
205208
[6]: https://sourceforge.net/projects/modules/lists/modules-interest
206-
[7]: https://x.com/EnvModules
207-
[8]: https://mast.hpc.social/@EnvModules
208-
[9]: https://bsky.app/profile/envmodules.bsky.social
209-
[10]: https://modules.readthedocs.io/en/latest/CONTRIBUTING.html
210-
[11]: CODE_OF_CONDUCT.md
211-
[12]: https://modules.readthedocs.io/en/latest/CHARTER.html
212-
[13]: https://github.com/envmodules/modules/graphs/contributors
213-
[14]: https://www.cea.fr/english
209+
[7]: https://matrix.to/#/#modules:matrix.org
210+
[8]: https://x.com/EnvModules
211+
[9]: https://mast.hpc.social/@EnvModules
212+
[10]: https://bsky.app/profile/envmodules.bsky.social
213+
[11]: https://modules.readthedocs.io/en/latest/CONTRIBUTING.html
214+
[12]: CODE_OF_CONDUCT.md
215+
[13]: https://modules.readthedocs.io/en/latest/CHARTER.html
216+
[14]: https://github.com/envmodules/modules/graphs/contributors
217+
[15]: https://www.cea.fr/english

doc/source/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,11 @@ Community
157157
---------
158158

159159
Modules is an open source project. Questions, discussion, and contributions
160-
are welcome. You can get in contact with the Modules community via the
161-
`modules-interest mailing list`_.
160+
are welcome. You can get in contact with the Modules community via:
161+
162+
* the `modules-interest mailing list`_
163+
164+
* the `Modules chat room`_ (``#modules:matrix.org``)
162165

163166
The project is also present on several social media platforms:
164167

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

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

0 commit comments

Comments
 (0)