Add doc for staying up to date with releases (#355)

xCDAT · Sep 27, 2022 · 3e57737 · 3e57737
1 parent 573947d
commit 3e57737
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -64,6 +64,24 @@ xCDAT invites discussion on version releases, architecture, new feature suggesti
 
 We welcome and appreciate contributions to xCDAT. If you'd like to help improve xCDAT, please checkout our `Contributing Guide <https://xcdat.readthedocs.io/en/latest/contributing.html>`_.
 
+Stay up to Date with Releases
+-----------------------------
+xCDAT (released as ``xcdat``) follows a rapid release cycle with continuous
+integration/continuous deployment. This means releases are made relatively frequently
+based on the importance of commits. The xCDAT core team reviews commits every two weeks
+to determine if they warrant a release.
+
+To be notified of releases through GitHub:
+
+1. Go to the ``xcdat`` repository homepage on GitHub (https://github.com/xCDAT/xcdat)
+2. Click the "Watch" button on the upper right-hand corner of the page.
+
+   .. image:: /docs/_static/github-watch-releases-1.png
+
+3. Click "Custom" and checkmark "Releases", then click "Apply".
+
+   .. image:: /docs/_static/github-watch-releases-2.png
+
 Planned Features
 ----------------
 

diff --git a/docs/_static/github-watch-releases-1.png b/docs/_static/github-watch-releases-1.png
diff --git a/docs/_static/github-watch-releases-2.png b/docs/_static/github-watch-releases-2.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -73,6 +73,24 @@ Things we are striving for:
 .. _cf_xarray: https://cf-xarray.readthedocs.io/en/latest/index.html
 .. _CF convention: http://cfconventions.org/
 
+Stay up to Date with Releases
+-----------------------------
+xCDAT (released as ``xcdat``) follows a rapid release cycle with continuous
+integration/continuous deployment. This means releases are made relatively frequently
+based on the importance of commits. The xCDAT core team reviews commits every two weeks
+to determine if they warrant a release.
+
+To be notified of releases through GitHub:
+
+1. Go to the ``xcdat`` repository homepage on GitHub (https://github.com/xCDAT/xcdat)
+2. Click the "Watch" button on the upper right-hand corner of the page.
+
+   .. image:: /_static/github-watch-releases-1.png
+
+3. Click "Custom" and checkmark "Releases", then click "Apply".
+
+   .. image:: /_static/github-watch-releases-2.png
+
 Acknowledgement
 ---------------