From: czichy Date: Tue, 29 Oct 2019 11:30:32 +0000 (+0200) Subject: Adding documentation files. Only the release notes file is actually relevant. X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=c08538fdb8b374ad2cf69686e2d86398644a074f;p=ric-plt%2Fasn1-documents.git Adding documentation files. Only the release notes file is actually relevant. Change-Id: I8944b167fef805ed9de28f6ddba038ba76fd889e Signed-off-by: czichy --- diff --git a/docs/api-docs.rst b/docs/api-docs.rst new file mode 100644 index 0000000..087b592 --- /dev/null +++ b/docs/api-docs.rst @@ -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 index 0000000..3841ea6 --- /dev/null +++ b/docs/developer-guides.rst @@ -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 index 0000000..f69a90e --- /dev/null +++ b/docs/installation-guides.rst @@ -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 index 0000000..1719996 --- /dev/null +++ b/docs/release-notes.rst @@ -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