add documentation page skeleton

Signed-off-by: weichen <niweichen@chinamobile.com>
Change-Id: I0a3cfcb285e24323e312ed877f1936460370e9ec

diff --git a/docs/amber.rst b/docs/amber.rst
new file mode 100644 (file)
index 0000000..302b310
--- /dev/null
+++ b/docs/amber.rst
@@ -0,0 +1,52 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) CMCC
+
+.. amber release project index
+
+
+O-RAN SC Amber Release Project
+==============================
+
+
+(Near Realtime) RICAPP
+----------------------
+* :doc:`RIC Measurement Campaign (MC) xApp <ric-app-mc:index>`
+
+(Near Realtime) RIC Platform
+----------------------------
+
+* :doc:`RIC Dashboard <portal-ric-dashboard:index>`
+
+NONRTRIC
+--------
+
+
+OAM
+---
+
+
+OCU
+---
+
+
+ODUHIGH
+-------
+
+
+ODULOW
+------
+
+
+INF
+---
+
+
+SIM
+---
+
+
+INT
+---
+
+

diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst
new file mode 100644 (file)
index 0000000..0243942
--- /dev/null
+++ b/docs/architecture/architecture.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 CMCC 
+
+
+O-RAN Architecture Overview
+===========================
+O-RAN SC architecture follows O-RAN Alliance defined architecture.
+
+
+.. image:: media/o-ran-architecture.png
+    :scale: 40 %
+
+Figure 1: O-RAN architecture overview
+
+In the O-RAN architecture, the radio side includes Near-RT RIC, O-CU-CP, O-CU-UP, O-DU, and O-RU. The management side includes Service Management and Orchestration Framework that contains a Non-RT-RIC function. 
+
+

diff --git a/docs/architecture/media/o-ran-architecture.png b/docs/architecture/media/o-ran-architecture.png
new file mode 100644 (file)
index 0000000..c12b5a1
Binary files /dev/null and b/docs/architecture/media/o-ran-architecture.png differ

diff --git a/docs/conf.py b/docs/conf.py
index aa2cfa2..b96756d 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,4 +7,6 @@ linkcheck_ignore = [
 ]
 
 intersphinx_mapping = {}
-intersphinx_mapping['portal-ric-dashboard'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-ric-dashboard/en/%s' % branch, None)
+intersphinx_mapping['ric-app-mc'] = ('https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-ric-app-mc/en/%s' % branch, None)
+
+intersphinx_mapping['portal-ric-dashboard'] = ('https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-portal-ric-dashboard/en/%s' % branch, None)

diff --git a/docs/index.rst b/docs/index.rst
index 2c66bb3..3680bb9 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,45 +1,31 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 CMCC
 
 .. _oran_master_doc:
 
 The O-RAN Software Community (SC) Documentation
 
+
 Welcome to O-RAN SC Documentation Home
 ======================================
 
-O-RAN Alliance members and contributors have committed to evolving
-Radio Access Networks (RAN) around the world. Future RANs will be
-built on a foundation of virtualized network elements, white-box
-hardware and standardized interfaces that fully embrace O-RAN’s core
-principles of intelligence and openness. An ecosystem of innovative
-new products is already emerging that will form the underpinnings of
-the multi-vendor, interoperable, autonomous RAN, envisioned by many
-in the past, but only now enabled by the global industry-wide vision,
-commitment and leadership of O-RAN Alliance members and contributors.
-
-O-RAN SC is partnering with the O-RAN Alliance and Linux Foundation to
-support the software development for an open RAN solution that is
-available to everyone. The community will align with the architecture
-and specifications that are created in the O-RAN Alliance working
-groups to create a working software solution to enable an open and
-intelligent 5G RAN.
-
-Please find some guidance here on the content of O-RAN SC
-documentation.
+O-RAN Alliance (https://www.o-ran.org/) members and contributors have committed to evolving Radio Access Networks (RAN) around the world. Future RANs will be built on a foundation of virtualized network elements, white-box hardware and standardized interfaces that fully embrace O-RAN’s core principles of intelligence and openness. An ecosystem of innovative new products is already emerging that will form the underpinnings of the multi-vendor, interoperable, autonomous RAN, envisioned by many in the past, but only now enabled by the global industry-wide vision, commitment and leadership of O-RAN Alliance members and contributors.
 
+O-RAN SC is partnering with the O-RAN Alliance and Linux Foundation to support the software development for an open RAN solution that is available to everyone. The community will align with the architecture and specifications that are created in the O-RAN Alliance working groups to create a working software solution to enable an open and intelligent 5G RAN.
 
-
-O-RAN SC components
-===================
+Please find some guidance here on the content of O-RAN SC documentation.
 
 .. toctree::
-   :maxdepth: 1
-
-
+   :maxdepth: 2
+   :caption: Contents:
 
+   architecture/architecture.rst
+   license.rst
+   release-notes.rst
+   amber.rst
 
-* :doc:`RIC Dashboard <portal-ric-dashboard:index>`
+.. * :doc:`RIC Dashboard <portal-ric-dashboard:index>`
 
 
 Indices and tables

diff --git a/docs/license.rst b/docs/license.rst
new file mode 100644 (file)
index 0000000..5a1bfe1
--- /dev/null
+++ b/docs/license.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+
+O-RAN SC license
+================
+
+The O-RAN Software initiatives are focused on aligning a software reference implementation with the O-RAN Alliance's open architecture and specifications. The aim is to achieve a solution that can be utilised to unify and accelerate the evolution and deployment in the RAN. The community has been setup to promote open source but also to address wireless technology support for essential patents.
+more infomation can be found at https://www.o-ran.org/software.
+
+
+Apache 2.0 License
+------------------
+The O-RAN Software Community is a Linux Foundation project supported and funded by O-RAN to lead the implementation of the O-RAN specifications in Open Source. The project leverages the Apache 2.0 License.
+
+
+O-RAN Software License
+----------------------
+The O-RAN Specification Code Project is an O-RAN Alliance project. Its objective is to allow contributions that will acknowledge essential patents. The project leverages the O-RAN Software License.
+
+
+

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..2958ce2
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,43 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 CMCC 
+
+Release-Notes
+=============
+
+
+This document provides the release notes for O-RAN SC.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-12         | 0.1.0              | Weichen Ni(CMCC)   | A Release draft    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    |                    |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+-------
+
+
+
+
+
+
+
+