Merge 0006718 into 754153f

mantidproject · Jan 6, 2021 · 5c146f9 · 5c146f9
2 parents 754153f + 0006718
commit 5c146f9
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 1 deletion.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -16,4 +16,4 @@
 
 ### Documentation
 
-*How have you changed the documentation to reflect your changes?*
+*How have you changed the documentation to reflect your changes? All changes should be noted in the appropriate file in docs/release_notes*
diff --git a/docs/developer_guide/documentation.rst b/docs/developer_guide/documentation.rst
@@ -80,3 +80,13 @@ It is also possible to use Sphinx to build the documentation as a Qt Help
 project.
 
 This can be done  with the command: :code:`python setup.py docs -b qthelp`.
+
+
+Release Notes
+-------------
+
+Release notes should be continuously updated during developement. Almost all pull requests should have an update to the relivent file and section in :file:`docs/release_notes`
+
+If the next release name is not yet chosen this will be :file:`next.rts`, and renamed closer to release.
+
+When fixes are backported to a release branch, they can be added to the notes for that release, in an updates section.
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,6 +19,7 @@ such as `Avizo
    developer_guide/index
    troubleshooting
    api
+   release_notes/index
 
 .. toctree::
    :caption: Links:

diff --git a/docs/release_notes/2.0.rst b/docs/release_notes/2.0.rst
@@ -0,0 +1,20 @@
+Mantid Imaging 2.0
+==================
+
+MantidImaging 2.0 is the first production ready release, suitable for a full neutron imaging and tomography workflow.
+
+New features
+------------
+
+* Auto loading of flat and dark frames
+* Loading of projection angles
+* PyQtGraph based stack viewers, for higher performance interactive data views
+* Compare window showing before vs after for operations
+* Safe apply of operations
+* ASTRA reconstruction algorithms
+
+
+Fixes
+-----
+
+Large number of fixes, clean ups and smaller improvements.
diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst
@@ -0,0 +1,9 @@
+Release Notes
+=============
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   2.0
+   next
diff --git a/docs/release_notes/next.rst b/docs/release_notes/next.rst
@@ -0,0 +1,12 @@
+Mantid Imaging next release
+===========================
+
+This contains changes for the next not yet released Mantid Imaging versions.
+
+New features
+------------
+
+
+Fixes
+-----
+