Release documentation: (#382)

jdsika · web-flow · commit c72297572eec · 2020-02-19T17:08:22.000+01:00
* Release documentation:

* Replace links to commit hash with link to release page

* replaced all commit hashs in release notes
diff --git a/doc/releases/v02.00.rst b/doc/releases/v02.00.rst
@@ -1,6 +1,5 @@
-v2.0.0 - OSI Initial Commit
+`v2.0.0 - OSI Initial Commit <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0>`_
 ============================
-`db6dd3f <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/db6dd3fabcca340e2aaf98c34d4959b63fb2b712>`_
 
 This is the initial version of the Open Simulation Interface (OSI).
 
@@ -23,4 +22,4 @@ OSI consists of two individual top level interfaces for object data: The ``OSI::
 - The ``OSI::SensorData`` interface describes the objects in the reference frame of a sensor for environmental perception. It is generated from a ``OSI::GroundTruth`` message and can either be used to directly connect to an automated driving function using ideal simulated data, or may serve as input for a sensor model simulating limited perception as a replication of real world sensor behavior.
 
 **Low level interfaces**:
-Additionally to the two top level interfaces, OSI contains an ``OSI::LowLevelData`` message. This message describes the output of a (physical) model of the measurement process before tracking and object hypothesis. It does not deal with object data, but may comprise the geometrical influence of 3D simulations e.g. generating Lidar point clouds with a ray-tracer plugin. In addition this message supports generic radar reflection lists and will be extended to supporting low level camera data in the future.
+Additionally to the two top level interfaces, OSI contains an ``OSI::LowLevelData`` message. This message describes the output of a (physical) model of the measurement process before tracking and object hypothesis. It does not deal with object data, but may comprise the geometrical influence of 3D simulations e.g. generating Lidar point clouds with a ray-tracer plugin. In addition this message supports generic radar reflection lists and will be extended to supporting low level camera data in the future.
diff --git a/doc/releases/v02.01.rst b/doc/releases/v02.01.rst
@@ -1,6 +1,5 @@
-v2.1.0 - OSI "Agile Andretti"
+`v2.1.0 - OSI "Agile Andretti"  <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0>`_
 ===============================
-`4fbc2e9 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/db6dd3fabcca340e2aaf98c34d4959b63fb2b712>`_
 
 Purpose:
 ----------
diff --git a/doc/releases/v02.02.rst b/doc/releases/v02.02.rst
@@ -1,6 +1,5 @@
-v2.2.0 - OSI "Brave Brabham"
+`v2.2.0 - OSI "Brave Brabham" <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0>`_
 ==============================
-`8950185 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/895018594421e0bd2a68013b2d32b2b729b076c4>`_
 
 Purpose:
 ---------
@@ -17,9 +16,8 @@ This release focuses on optimizing the build process and documentation.
 - Added layer id to low level point cloud data.
 - Reworked large parts of the build instructions in the WIKI.
 
-v2.2.1 - OSI "Brave Brabham", Update 1
+`v2.2.1 - OSI "Brave Brabham", Update 1 <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1>`_
 ========================================
-`ca21a73 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/ca21a731e35a96ba3f91ef6cdf4365115ec3f332>`_
 
 Purpose:
 ---------
diff --git a/doc/releases/v03.00.rst b/doc/releases/v03.00.rst
@@ -1,6 +1,5 @@
-v3.0.0 - OSI "Cosmic Coulthard"
+`v3.0.0 - OSI "Cosmic Coulthard" <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0>`_
 =================================
-`12720ba <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/12720baf67624d7312db0b556dcc5e5da700e349>`_
 
 Purpose:
 ---------
@@ -38,9 +37,8 @@ We are aligned with the ongoing discussions for the upcoming ISO 23150 standard
 
 See for more information the `changelog <https://github.com/OpenSimulationInterface/open-simulation-interface/files/2297162/osi_overview_v2.2_vs_v3.0.pdf>`_.
 
-v3.0.1 - OSI "Cosmic Coulthard", Update 1
+`v3.0.1 - OSI "Cosmic Coulthard", Update 1 <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1>`_
 ==========================================
-`d144f0c <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/d144f0c8e5cde5471c8c3cdd5d43facfe37e4a08>`_
 
 `Summertime :) <https://www.youtube.com/watch?v=yG0oBPtyNb0>`_
 
@@ -60,4 +58,3 @@ This release is a patch reworking parts of the documentation in order to avoid a
 - signal_strength definition in LidarSensorView corrected
 - FeatureData::ambiguity_id definition clarified
 - RadarSensorViewConfiguration::AntennaDiagram::response definition clarified
-
diff --git a/doc/releases/v03.01.rst b/doc/releases/v03.01.rst
@@ -1,6 +1,5 @@
-v3.1.0 - OSI "Dynamic Duncan"
+`v3.1.0 - OSI "Dynamic Duncan" <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0>`_
 ==============================
-`d3455a6 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/d3455a6b18dffad59a166edd21462aaaac9be1e3>`_
 
 `(O SI)lent night <https://www.youtube.com/watch?v=fu3uA8K6ApQ>`_
 
@@ -23,27 +22,16 @@ This time of the year Santa comes with presents and has also thought about the s
 - Introduced raster_lidar_proposal from innoviz.
 - Improved documentation with HTML tables and images for all traffic signs.
 
-v3.1.1 - OSI "Dynamic Duncan", Update 1
+`v3.1.1 - OSI "Dynamic Duncan", Update 1 <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1>`_
 ==========================================
-`448d399 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/448d3992d4d4e5547a2ad8781b124235bc3eec86>`_
-
-
-Purpose:
----------
-In Progress ..
 
 `Content/Changes <https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1>`_:
 ---------------------------------------------------------------------------------------------------------------------------------------------
 - **Bug Fix**: Changed open_simulation_interface target back from being a static library to a shared library, as before (this reverts an inadvertent change in v3.1.0 from previous releases). v3.1.0 breaks all users of the shared library (i.e. everyone building on Linux/Unix systems, and even some using the DLL on Windows).
 
-v3.1.2 - OSI "Dynamic Duncan", Update 2
+`v3.1.2 - OSI "Dynamic Duncan", Update 2 <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2>`_
 ==========================================
-`b07b6d2 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/b07b6d2677c89da48c73b69cc5403a20dfd22bc4>`_
-
-Purpose:
----------
-In Progress ..
 
-Content/Changes:
+`Content/Changes <https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.2>`_:
 -----------------
 - **Bugfix**: The version number is now correct in the VERSION file.
diff --git a/doc/releases/v03.02.rst b/doc/releases/v03.02.rst
@@ -1,6 +1,5 @@
-v3.2.0 - OSI "Editorial Eaton"
+`v3.2.0 - OSI "Editorial Eaton" <https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0>`_
 ==============================
-TODO: `d3455a6 <https://github.com/OpenSimulationInterface/open-simulation-interface/commit/d3455a6b18dffad59a166edd21462aaaac9be1e3>`_
 
 `Think p(OSI)tive! <https://www.youtube.com/watch?v=SJUhlRoBL8M>`_
 
