Adding documentation files. Only the release notes file is actually relevant. 60/1260/1
authorczichy <thoralf.czichy@nokia.com>
Tue, 29 Oct 2019 11:30:32 +0000 (13:30 +0200)
committerczichy <thoralf.czichy@nokia.com>
Tue, 29 Oct 2019 11:31:30 +0000 (13:31 +0200)
Change-Id: I8944b167fef805ed9de28f6ddba038ba76fd889e
Signed-off-by: czichy <thoralf.czichy@nokia.com>
docs/api-docs.rst [new file with mode: 0644]
docs/developer-guides.rst [new file with mode: 0644]
docs/installation-guides.rst [new file with mode: 0644]
docs/release-notes.rst [new file with mode: 0644]

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
new file mode 100644 (file)
index 0000000..087b592
--- /dev/null
@@ -0,0 +1,28 @@
+.. 
+..  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.
+..
+
+.. contents::
+   :depth: 3
+   :local:
+
+API-docs
+============
+
+The API (ASN.1 definitions) ae defined in the E2AP document and a copy of the ASN.1 is in the ASN.1 file of 
+this repository. This is the version of the E2 that the near-RT RIC platform is implemented against.
+
diff --git a/docs/developer-guides.rst b/docs/developer-guides.rst
new file mode 100644 (file)
index 0000000..3841ea6
--- /dev/null
@@ -0,0 +1,27 @@
+.. 
+..  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.
+..
+
+.. contents::
+   :depth: 3
+   :local:
+
+Developer-Guides
+================
+
+This component only provides what is listed in API docs.
+
diff --git a/docs/installation-guides.rst b/docs/installation-guides.rst
new file mode 100644 (file)
index 0000000..f69a90e
--- /dev/null
@@ -0,0 +1,21 @@
+.. 
+..  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.
+..
+
+Since this component/repository only contains ASN.1 definitions and relatd documentation there is no installation
+guide for it. The api-docs contains more information.
+
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..1719996
--- /dev/null
@@ -0,0 +1,30 @@
+.. 
+..  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.
+..
+
+
+This document provides the release notes for the latest release of the near-RT RIC component "asn1-documents".
+
+.. contents::
+   :depth: 3
+      :local:
+
+Version 1.0.0, October 2019
+---------------------------
+* initial version 
+* E2AP document version (PDF, DOC) used in near-RT RIC project
+* ASN.1 copy of the ASN.1 definitions in DOC/PDF document