From b0f4a7d0f57553d13cf78b81f4f97f423a49f0c9 Mon Sep 17 00:00:00 2001 From: Nicolas Tessore Date: Wed, 31 May 2023 15:04:34 +0100 Subject: [PATCH] DOC: add announcement mailing list information (#95) Add information about the mailing list for announcements of new GLASS releases. Fixes: #66 --- README.md | 12 ++++++++++++ docs/manual/installation.rst | 16 ++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/README.md b/README.md index e4ec92ac..819f74c8 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,20 @@ e.g. a design decision or API change, you can use our [Discussions] page. We also have a public [Slack workspace] for discussions about the project. +To keep up with new GLASS releases, you can receive GitHub release +notifications from this repository. Alternatively, you can subscribe to our +announcement mailing list, which only receives 1 email/release. To subscribe, +use the [mailing list page], or send an email to `listserv@jiscmail.ac.uk` with +any subject and the following message body: + + subscribe glass + +where `` is your full name, or `ANONYMOUS` if you prefer. You will +be sent a confirmation email in return. + [documentation]: https://glass.readthedocs.io/ [examples]: https://glass.readthedocs.io/projects/examples/ [Discussions]: https://github.com/orgs/glass-dev/discussions [Slack workspace]: https://glass-dev.github.io/slack +[mailing list page]: https://jiscmail.ac.uk/lists/GLASS.html diff --git a/docs/manual/installation.rst b/docs/manual/installation.rst index 792925ea..02cf1555 100644 --- a/docs/manual/installation.rst +++ b/docs/manual/installation.rst @@ -61,3 +61,19 @@ There currently are a fair amount of breaking changes between *GLASS* releases. For production use, it is therefore **strongly** recommended that you install *GLASS* in a clean environment (venv, conda, etc.) and **pin the GLASS version for the duration of your project**. + + +Announcements +------------- + +To keep up with new GLASS releases, you can subscribe to our announcement +mailing list, which only receives 1 email per release. To subscribe, use the +`mailing list page`__, or send an email to ``listserv@jiscmail.ac.uk`` with any +subject and the following message body:: + + subscribe glass + +where ```` is your full name, or ``ANONYMOUS`` if you prefer. You +will be sent a confirmation email in return. + +__ https://jiscmail.ac.uk/lists/GLASS.html