Skip to content

Commit b9ebda8

Browse files
committed
update release guide to use contact info
1 parent d659236 commit b9ebda8

File tree

4 files changed

+39
-17
lines changed

4 files changed

+39
-17
lines changed

doc/_static/mpl.css

+19
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,22 @@ div.wide-table table th.stub {
161161
font-style: italic;
162162
font-size: large;
163163
}
164+
165+
166+
.checklist {
167+
list-style: none;
168+
padding: 0;
169+
margin: 0;
170+
}
171+
.checklist li {
172+
margin-left: 24px;
173+
padding-left: 23px;
174+
margin-right: 6px;
175+
}
176+
.checklist li:before {
177+
content: "\2610\2001";
178+
margin-left: -24px;
179+
}
180+
.checklist li p {
181+
display: inline;
182+
}

doc/devel/communication_guide.rst

+7-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ for example at sprints or when giving official talks or tutorials, and in any
99
community venue managed by Matplotlib.
1010

1111

12-
1312
.. _communication-channels:
1413

1514
Official communication channels
@@ -21,6 +20,8 @@ The following venues are managed by Matplotlib maintainers and contributors:
2120
* chat: `https://matrix.to/#/#matplotlib:matrix.org <https://matrix.to/#/#matplotlib:matrix.org>`_
2221
* blog: https://blog.scientific-python.org/
2322

23+
.. _social-media:
24+
2425
Social media
2526
------------
2627

@@ -38,12 +39,14 @@ Official accounts
3839
* https://www.youtube.com/matplotlib
3940

4041

42+
.. _mailing-lists:
43+
4144
Mailing lists
4245
-------------
4346

44-
* https://mail.python.org/mailman/listinfo/matplotlib-announce
45-
* https://mail.python.org/mailman/listinfo/matplotlib-users
46-
* https://mail.python.org/mailman/listinfo/matplotlib-devel
47+
* `[email protected] <https://mail.python.org/mailman/listinfo/matplotlib-announce>`_
48+
* `[email protected] <https://mail.python.org/mailman/listinfo/matplotlib-users>`_
49+
* `[email protected] <https://mail.python.org/mailman/listinfo/matplotlib-devel>`_
4750

4851
.. _social-media-coordination:
4952

doc/devel/release_guide.rst

+12-13
Original file line numberDiff line numberDiff line change
@@ -455,22 +455,21 @@ Due to branch protections for the ``main`` branch, this is merged via a standard
455455
request, though the PR cleanliness status check is expected to fail. The PR should not
456456
be squashed because the intent is to merge the branch histories.
457457

458-
Announcing
459-
==========
458+
Publicize this release
459+
======================
460460

461-
The final step is to announce the release to the world. A short
462-
version of the release notes along with acknowledgments should be sent to
461+
After the release is published to PyPI and conda, it should be announced
462+
through our communication channels:
463463

464-
465-
466-
467-
468-
In addition, announcements should be made on social networks (e.g., Twitter via the
469-
``@matplotlib`` account, any other via personal accounts).
470-
471-
Add a release announcement to the ``mpl-brochure-site`` "News" section of
472-
``docs/body.html``, linking to the discourse page for the announcement.
464+
.. rst-class:: checklist
473465

466+
* Send a short version of the release notes and acknowledgments to all the :ref:`mailing-lists`
467+
* Post highlights and link to :ref:`What's new <release-notes>` on the
468+
active :ref:`social media accounts <social-media>`
469+
* Add a release announcement to the "News" section of
470+
`matplotlib.org <https://github.com/matplotlib/mpl-brochure-site>`_ by editing
471+
``docs/body.html``. Link to the auto-generated announcement discourse post,
472+
which is in `Announcements > matplotlib-announcements <https://discourse.matplotlib.org/c/announce/matplotlib-announce/10>`_.
474473

475474
Conda packages
476475
==============

doc/users/release_notes.rst

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.. redirect-from:: /api/api_changes_old
22
.. redirect-from:: /users/whats_new_old
33

4+
.. _release-notes:
45

56
=============
67
Release notes

0 commit comments

Comments
 (0)