Merge pull request #194 from BCDA-APS/189-CHANGES-file

keep a history of changes between versions
BCDA-APS · Jun 5, 2023 · 4402a82 · 4402a82
2 parents aa0c942 + de47099
commit 4402a82
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -0,0 +1,37 @@
+..
+   Subsections could include these headings (in this order).
+   Only include a subsection if there is content.
+
+   Notice
+   Breaking Changes
+   New Features
+   Enhancements
+   Fixes
+   Maintenance
+   Deprecations
+   Known Problems
+   New Contributors
+
+Changes
+#######
+
+History of user-visible changes between the versions.
+
+Project `milestones <https://github.com/BCDA-APS/bluesky_training/milestones>`_
+describe future plans.
+
+..
+   1.0.1
+   ******
+
+   release expected by 2023-06-30
+
+1.0.0
+******
+
+Released 2023-06-05.
+
+Notice
+------
+
+* Initial tag
diff --git a/docs/source/changes.rst b/docs/source/changes.rst
@@ -0,0 +1,7 @@
+..
+        CHANGES
+        =======
+        
+        title provided in CHANGES.rst file
+
+.. include:: ../../CHANGES.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -49,6 +49,7 @@ serves as a template for new beamline installations.
    example/index
    tutor/index
    reference/index
+   changes
 
 Other resources
 ==================
@@ -77,6 +78,8 @@ Other resources
 * APS Data Management
    * home: https://confluence.aps.anl.gov/display/DMGT/
 
+   changes
+
 Index
 ==================