From 75af0cef5b6e5257b5116df82653556a700814cb Mon Sep 17 00:00:00 2001 From: Paul Natsuo Kishimoto Date: Tue, 21 Jan 2025 14:35:11 +0100 Subject: [PATCH] Link to newsletter in README, doc/index - Copyedit some typos. - Reflow text. --- README.md | 20 ++++++++++++++------ doc/index.rst | 15 ++++++++++----- 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6fa2ee57b..5bc40fb39 100644 --- a/README.md +++ b/README.md @@ -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. @@ -39,7 +39,7 @@ 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. @@ -47,11 +47,19 @@ Other forms of documentation: ## 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 diff --git a/doc/index.rst b/doc/index.rst index 2ec50e045..605c9aec1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_ or start a new one with your question. +- Check on GitHub: + + - Join an existing `discussion `_ or start a new one with your MESSAGEix usage question. - Search `current issues `_, or open a new one to report a bug in the code. -- …the :doc:`faq`. -- …the message_ix Google Group, either `online `_ or via e-mail at . +- See the less frequently updated :doc:`faq` and message_ix Google Group, either `online `_ or via e-mail at . + +.. _newsletter: + +- We cordially invite you to subscribe to the **MESSAGEix Community Newsletter** by filling `this form `__ 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