From ab1f555a849dd68754bcd2436878535c5de28aef Mon Sep 17 00:00:00 2001 From: Martyn Gigg <martyn.gigg@gmail.com> Date: Fri, 23 Sep 2016 16:16:01 +0100 Subject: [PATCH] Add skeleton release note pages for v3.9.0 --- docs/source/release/index.rst | 1 + docs/source/release/v3.9.0/diffraction.rst | 18 +++++ .../release/v3.9.0/direct_inelastic.rst | 9 +++ docs/source/release/v3.9.0/framework.rst | 46 +++++++++++++ docs/source/release/v3.9.0/index.rst | 68 +++++++++++++++++++ .../release/v3.9.0/indirect_inelastic.rst | 27 ++++++++ docs/source/release/v3.9.0/muon.rst | 23 +++++++ docs/source/release/v3.9.0/reflectometry.rst | 23 +++++++ docs/source/release/v3.9.0/sans.rst | 13 ++++ docs/source/release/v3.9.0/ui.rst | 47 +++++++++++++ 10 files changed, 275 insertions(+) create mode 100644 docs/source/release/v3.9.0/diffraction.rst create mode 100644 docs/source/release/v3.9.0/direct_inelastic.rst create mode 100644 docs/source/release/v3.9.0/framework.rst create mode 100644 docs/source/release/v3.9.0/index.rst create mode 100644 docs/source/release/v3.9.0/indirect_inelastic.rst create mode 100644 docs/source/release/v3.9.0/muon.rst create mode 100644 docs/source/release/v3.9.0/reflectometry.rst create mode 100644 docs/source/release/v3.9.0/sans.rst create mode 100644 docs/source/release/v3.9.0/ui.rst diff --git a/docs/source/release/index.rst b/docs/source/release/index.rst index 49dff855257..37b1263bc7c 100644 --- a/docs/source/release/index.rst +++ b/docs/source/release/index.rst @@ -6,6 +6,7 @@ Release Notes :maxdepth: 1 :titlesonly: + v3.9.0 <v3.9.0/index> v3.8.0 <v3.8.0/index> v3.7.1 <v3.7.1/index> v3.6.1 <v3.6.1/index> diff --git a/docs/source/release/v3.9.0/diffraction.rst b/docs/source/release/v3.9.0/diffraction.rst new file mode 100644 index 00000000000..77765745954 --- /dev/null +++ b/docs/source/release/v3.9.0/diffraction.rst @@ -0,0 +1,18 @@ +=================== +Diffraction Changes +=================== + +.. contents:: Table of Contents + :local: + +Crystal Improvements +-------------------- + +Engineering Diffraction +----------------------- + +| + +Full list of `diffraction <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Diffraction%22>`_ +and +`imaging <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Imaging%22>`_ changes on GitHub. diff --git a/docs/source/release/v3.9.0/direct_inelastic.rst b/docs/source/release/v3.9.0/direct_inelastic.rst new file mode 100644 index 00000000000..066eea7e94b --- /dev/null +++ b/docs/source/release/v3.9.0/direct_inelastic.rst @@ -0,0 +1,9 @@ +======================== +Direct Inelastic Changes +======================== + +.. contents:: Table of Contents + :local: + +`Full list of changes on GitHub <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Direct+Inelastic%22>`_ + diff --git a/docs/source/release/v3.9.0/framework.rst b/docs/source/release/v3.9.0/framework.rst new file mode 100644 index 00000000000..83fa05432a2 --- /dev/null +++ b/docs/source/release/v3.9.0/framework.rst @@ -0,0 +1,46 @@ +================= +Framework Changes +================= + +.. contents:: Table of Contents + :local: + +Algorithms +---------- + +New +### + + +Improved +######## + + +Deprecated +########## + +MD Algorithms (VATES CLI) +######################### + +Performance +----------- + +CurveFitting +------------ + +Improved +######## + +Python +------ + +Python Algorithms +################# + +| + +Full list of +`Framework <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Framework%22>`__ +and +`Python <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Python%22>`__ +changes on GitHub diff --git a/docs/source/release/v3.9.0/index.rst b/docs/source/release/v3.9.0/index.rst new file mode 100644 index 00000000000..7ecf71a2244 --- /dev/null +++ b/docs/source/release/v3.9.0/index.rst @@ -0,0 +1,68 @@ +========================== +Mantid 3.9.0 Release Notes +========================== + +.. figure:: ../../images/ReleaseUnderConstruction.jpg + :class: screenshot + :width: 550px + :align: right + + Release image + +.. contents:: Table of Contents + :local: + +.. warning:: This release is still under construction. The changes can be found in the nightly builds on the `download page`_. + +**TODO: Add paragraph summarizing big changes** + +This is just one of many improvements in this release, so please take a +look at the release notes, which are filled with details of the +important changes and improvements in many areas. The development team +has put a great effort into making all of these improvements within +Mantid, and we would like to thank all of our beta testers for their +time and effort helping us to make this another reliable version of Mantid. + +Throughout the Mantid project we put a lot of effort into ensuring +Mantid is a robust and reliable product. Thank you to everyone that has +reported any issues to us. Please keep on reporting any problems you +have, or crashes that occur on our `forum`_. + +Installation packages can be found on our `download page`_ +which now links to sourceforge to mirror our download files around the world, you can also +access the source code on `GitHub release page`_. + +Citation +-------- + +Please cite any usage of Mantid as follows: + +- *Mantid 3.9: Manipulation and Analysis Toolkit for Instrument Data.; Mantid Project*. doi: http://dx.doi.org/10.5286/SOFTWARE/MANTID3.9 + +Changes +------- + +.. toctree:: + :titlesonly: + + Framework <framework> + User Interface & Usability <ui> + Direct Inelastic <direct_inelastic> + Indirect Inelastic <indirect_inelastic> + SANS <sans> + Diffraction <diffraction> + Muon Analysis <muon> + Reflectometry <reflectometry> + +Full Change Listings +-------------------- + +For a full list of all issues addressed during this release please see the `GitHub milestone`_. + +.. _download page: http://download.mantidproject.org + +.. _forum: http://forum.mantidproject.org + +.. _GitHub milestone: http://github.com/mantidproject/mantid/pulls?utf8=%E2%9C%93&q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Aclosed + +.. _GitHub release page: https://github.com/mantidproject/mantid/releases/tag/v3.9.0 diff --git a/docs/source/release/v3.9.0/indirect_inelastic.rst b/docs/source/release/v3.9.0/indirect_inelastic.rst new file mode 100644 index 00000000000..f14c56f7c59 --- /dev/null +++ b/docs/source/release/v3.9.0/indirect_inelastic.rst @@ -0,0 +1,27 @@ +========================== +Indirect Inelastic Changes +========================== + +.. contents:: Table of Contents + :local: + +New features +------------ + +Algorithms +########## + +Data Analysis +############# + +Jump Fit +~~~~~~~~ + +Improvements +------------ + + +Bugfixes +-------- + +`Full list of changes on GitHub <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Indirect+Inelastic%22>`_ diff --git a/docs/source/release/v3.9.0/muon.rst b/docs/source/release/v3.9.0/muon.rst new file mode 100644 index 00000000000..5595a2b0d94 --- /dev/null +++ b/docs/source/release/v3.9.0/muon.rst @@ -0,0 +1,23 @@ +============= +Muon Analysis +============= + +.. contents:: Table of Contents + :local: + +Interfaces +---------- + +Muon Analysis +############# + +Algorithms +---------- + +Fit Functions +------------- + +| + +`Full list of changes <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Muon%22>`_ +on GitHub. diff --git a/docs/source/release/v3.9.0/reflectometry.rst b/docs/source/release/v3.9.0/reflectometry.rst new file mode 100644 index 00000000000..77c0d03cf88 --- /dev/null +++ b/docs/source/release/v3.9.0/reflectometry.rst @@ -0,0 +1,23 @@ +===================== +Reflectometry Changes +===================== + +.. contents:: Table of Contents + :local: + +ConvertToReflectometryQ +----------------------- + + +Reflectometry Reduction Interface +--------------------------------- + +ISIS Reflectometry (Polref) +########################### + +ISIS Reflectometry +################## + +| + +`Full list of changes on github <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Reflectometry%22>`__ diff --git a/docs/source/release/v3.9.0/sans.rst b/docs/source/release/v3.9.0/sans.rst new file mode 100644 index 00000000000..9c26c44177e --- /dev/null +++ b/docs/source/release/v3.9.0/sans.rst @@ -0,0 +1,13 @@ +============ +SANS Changes +============ + +.. contents:: Table of Contents + :local: + +Bug Fixes +--------- + +| + +`Full list of changes on github <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+SANS%22>`__ diff --git a/docs/source/release/v3.9.0/ui.rst b/docs/source/release/v3.9.0/ui.rst new file mode 100644 index 00000000000..baea590ba61 --- /dev/null +++ b/docs/source/release/v3.9.0/ui.rst @@ -0,0 +1,47 @@ +====================== +UI & Usability Changes +====================== + +.. contents:: Table of Contents + :local: + +Installation +------------ + +Windows +####### + +OS X +#### + +User Interface +-------------- + +Instrument View +############### + +Plotting Improvements +##################### + +Algorithm Toolbox +################# + +Scripting Window +################ + +Documentation +############# + +Bugs Resolved +------------- + +SliceViewer Improvements +------------------------ + +| + +Full list of +`GUI <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+GUI%22>`_ +and +`Documentation <http://github.com/mantidproject/mantid/pulls?q=is%3Apr+milestone%3A%22Release+3.9%22+is%3Amerged+label%3A%22Component%3A+Documentation%22>`_ +changes on GitHub -- GitLab