Add docs building support

[ric-plt/jaegeradapter.git] / docs / release-notes.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..ddd9df8
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,117 @@
+..
+.. Copyright (c) 2019 AT&T Intellectual Property.
+..
+.. Copyright (c) 2019 Nokia.
+..
+..
+.. Licensed under the Creative Commons Attribution 4.0 International
+..
+.. Public License (the "License"); you may not use this file except
+..
+.. in compliance with the License. You may obtain a copy of the License at
+..
+..
+..     https://creativecommons.org/licenses/by/4.0/
+..
+..
+.. Unless required by applicable law or agreed to in writing, documentation
+..
+.. distributed under the License is distributed on an "AS IS" BASIS,
+..
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+..
+.. See the License for the specific language governing permissions and
+..
+.. limitations under the License.
+..
+
+
+Release-Notes
+=============
+
+
+This document provides the release notes for version 1.0.0 of jaegeradapter.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-13         | 0.1.0              | R Riska            | First version      |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+-------
+
+This is the first version of this component.
+
+
+
+
+Release Data
+------------
+This is the first version of this component.
+The repository contains jaeger configuration files.
+This first version only supports configuration for a jaeger-all-in-one deployment.
+
+
+
+
+Feature Additions
+^^^^^^^^^^^^^^^^^
+
+Bug Corrections
+^^^^^^^^^^^^^^^
+
+
+Deliverables
+^^^^^^^^^^^^
+
+Software Deliverables
++++++++++++++++++++++
+
+- Helm charts for deploying a jaeger-all-in-one container
+- A config map for creating a trace client configuration for clients using ric-plt/tracelibcpp or ric-plt/tracelibgo
+
+These components can be retrieved from https://gerrit.o-ran-sc.org/r/ric-plt/jaegeradapter.git.
+
+
+
+Documentation Deliverables
+++++++++++++++++++++++++++
+
+
+
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+^^^^^^^^^^^^^^^^^^
+
+
+
+Known Issues
+^^^^^^^^^^^^
+
+Workarounds
+^^^^^^^^^^^
+
+
+
+
+
+References
+----------
+
+