Skip to content

Commit

Permalink
Link to newsletter in README, doc/index
Browse files Browse the repository at this point in the history
- Copyedit some typos.
- Reflow text.
  • Loading branch information
khaeru committed Jan 21, 2025
1 parent bbcc9e7 commit 75af0ce
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ The `message_ix` Python package—also fully usable from R—includes:
- Application programming interfaces (APIs) and tools for model building and scientific programming,
- Extensive documentation and a complete test suite.

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.
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.

## Documentation

Complete documentation of the framework is avaiable at **https://docs.messageix.org/**.
Complete documentation of the framework is available at **https://docs.messageix.org**.
This includes:

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

- The online documentation is built automatically from the contents of the
[`message_ix` GitHub repository](https://github.com/iiasa/messag_ix).
[`message_ix` GitHub repository](https://github.com/iiasa/message_ix).
- Documentation for the ‘latest’ or ‘stable’ release is shown by default.
- 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`.
- For offline use, the documentation can be built from the source code.
See the file [`doc/README.rst`](doc/README.rst)

## Commitment to our Community

- 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.
- 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.
- 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).
- 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).
- We highly value code security. To learn more about our security practice and advice, please visit our [security policy](.github/SECURITY.md).
- 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).
- We highly value code security.
To learn more about our security practice and advice, please visit our [security policy](.github/SECURITY.md).
- 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).
- We also:
- Host an annual [MESSAGEix Community Meeting](https://iiasa.ac.at/search?search_api_fulltext=MESSAGEix+Community+Meeting).
- Publish, at least once per year, a community newsletter.
You are cordially invited to subscribe by filling [this form](https://iiasa.ac.at/signup) and ticking the box for “MESSAGEix Community”.


## License

Expand Down
15 changes: 10 additions & 5 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,20 @@ Everyone is required to please follow our Code of Conduct, which you can find `o

.. _help:

Have a question? Check…

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

- Join an existing `discussion <https://github.com/iiasa/message_ix/discussions>`_ or start a new one with your question.
- Check on GitHub:

- Join an existing `discussion <https://github.com/iiasa/message_ix/discussions>`_ or start a new one with your MESSAGEix usage question.
- 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.

- …the :doc:`faq`.
- …the message_ix Google Group, either `online <https://groups.google.com/d/forum/message_ix>`_ or via e-mail at <[email protected]>.
- 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]>.

.. _newsletter:

- 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".
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`__.

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

0 comments on commit 75af0ce

Please sign in to comment.