Skip to content

Commit 75af0ce

Browse files
committed
Link to newsletter in README, doc/index
- Copyedit some typos. - Reflow text.
1 parent bbcc9e7 commit 75af0ce

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ The `message_ix` Python package—also fully usable from R—includes:
2020
- Application programming interfaces (APIs) and tools for model building and scientific programming,
2121
- Extensive documentation and a complete test suite.
2222

23-
The framework is built on IIASA's [*ix* modeling platform (`ixmp`)](https://github.com/iiasa/ixmp), which provides data warehouse features for high-powered numerical scenario analysis.
23+
The framework is built on IIASA's [*ix* modeling platform (`ixmp`)](https://github.com/iiasa/ixmp), which provides data warehouse features for numerical scenario analysis.
2424

2525
## Documentation
2626

27-
Complete documentation of the framework is avaiable at **https://docs.messageix.org/**.
27+
Complete documentation of the framework is available at **https://docs.messageix.org**.
2828
This includes:
2929

3030
- **Installation** and recommended pre-requisite learning.
@@ -39,19 +39,27 @@ This includes:
3939
Other forms of documentation:
4040

4141
- The online documentation is built automatically from the contents of the
42-
[`message_ix` GitHub repository](https://github.com/iiasa/messag_ix).
42+
[`message_ix` GitHub repository](https://github.com/iiasa/message_ix).
4343
- Documentation for the ‘latest’ or ‘stable’ release is shown by default.
4444
- Use the chooser to access the [‘latest’ version](https://docs.messageix.org/en/latest/), corresponding to the ``main`` branch and including the latest development code; or to access docs for a specific release, e.g. `v3.2.0`.
4545
- For offline use, the documentation can be built from the source code.
4646
See the file [`doc/README.rst`](doc/README.rst)
4747

4848
## Commitment to our Community
4949

50-
- We aim to create a community that is welcoming to everyone. Please respect our [Code of Conduct](CODE_OF_CONDUCT.md) at all times when interacting with `message_ix` and the community.
50+
- We aim to create a community that is welcoming to everyone.
51+
Please respect our [Code of Conduct](CODE_OF_CONDUCT.md) at all times when interacting with `message_ix` and the community.
5152
- We warmly welcome all contributions to our community. Please take a look at our [guidelines for contributing to development](https://docs.messageix.org/en/latest/contributing.html).
5253
- If you are looking to understand how the `message_ix` team operates and how we decide what to do with your contributions, please read our [governance guidelines](GOVERNANCE.md).
53-
- We highly value code security. To learn more about our security practice and advice, please visit our [security policy](.github/SECURITY.md).
54-
- We strive to entertain a welcoming and inclusive community. If you struggle to use `message_ix`, please check our [guidelines for getting support](SUPPORT.md).
54+
- We highly value code security.
55+
To learn more about our security practice and advice, please visit our [security policy](.github/SECURITY.md).
56+
- We strive to entertain a welcoming and inclusive community.
57+
If you struggle to use `message_ix`, please check our [guidelines for getting support](SUPPORT.md).
58+
- We also:
59+
- Host an annual [MESSAGEix Community Meeting](https://iiasa.ac.at/search?search_api_fulltext=MESSAGEix+Community+Meeting).
60+
- Publish, at least once per year, a community newsletter.
61+
You are cordially invited to subscribe by filling [this form](https://iiasa.ac.at/signup) and ticking the box for “MESSAGEix Community”.
62+
5563

5664
## License
5765

doc/index.rst

+10-5
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,20 @@ Everyone is required to please follow our Code of Conduct, which you can find `o
143143

144144
.. _help:
145145

146-
Have a question? Check…
147146

148-
- …on GitHub:
147+
For further information and to get involved with the MESSAGEix user/developer community:
149148

150-
- Join an existing `discussion <https://github.com/iiasa/message_ix/discussions>`_ or start a new one with your question.
149+
- Check on GitHub:
150+
151+
- Join an existing `discussion <https://github.com/iiasa/message_ix/discussions>`_ or start a new one with your MESSAGEix usage question.
151152
- Search `current issues <https://github.com/iiasa/message_ix/issues?q=is:issue>`_, or open a new one to report a bug in the code.
152153

153-
- …the :doc:`faq`.
154-
- …the message_ix Google Group, either `online <https://groups.google.com/d/forum/message_ix>`_ or via e-mail at <[email protected]>.
154+
- See the less frequently updated :doc:`faq` and message_ix Google Group, either `online <https://groups.google.com/d/forum/message_ix>`_ or via e-mail at <[email protected]>.
155+
156+
.. _newsletter:
157+
158+
- We cordially invite you to subscribe to the **MESSAGEix Community Newsletter** by filling `this form <https://iiasa.ac.at/signup>`__ and ticking the box for "MESSAGEix-Community".
159+
At least once a year, we update all subscribers on the latest research and ongoing projects regarding MESSAGEix and invite you to our annual `Community Meeting <https://iiasa.ac.at/search?search_api_fulltext=MESSAGEix+Community+Meeting`__.
155160

156161
.. _`MESSAGEix-GLOBIOM documentation`: http://data.ene.iiasa.ac.at/message-globiom/
157162
.. _`APACHE 2.0 open-source license`: https://github.com/iiasa/message_ix/blob/main/LICENSE

0 commit comments

Comments
 (0)