Skelton for documentation

Prepared skelton for documentation.

Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
Change-Id: Iad75c08ab1dd5d1d4f865d18521bead91dd0f2ac

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644 (file)
index 0000000..c3b6ce5
Binary files /dev/null and b/docs/_static/logo.png differ

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..07032ac
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,7 @@
+from docs_conf.conf import *
+
+linkcheck_ignore = [
+    'http://localhost.*',
+    'http://127.0.0.1.*',
+    'https://gerrit.o-ran-sc.org.*'
+]

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..5da838b
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: oran
+project: ric-plt-ricdms

diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644 (file)
index 0000000..00b0fd0
Binary files /dev/null and b/docs/favicon.ico differ

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..b181d12
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2021 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2021
+
+
+Welcome to O-RAN SC HW-go Documentation
+========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   overview.rst
+   release-notes.rst
+   installation-guide.rst
+   user-guide.rst
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
new file mode 100644 (file)
index 0000000..32218cc
--- /dev/null
+++ b/docs/installation-guide.rst
@@ -0,0 +1,42 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2021 Samsung Electronics Co., Ltd. All Rights Reserved.
+
+
+Installation Guide
+==================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Abstract
+--------
+
+This document describes how to install the reference RICDMS.
+
+
+Introduction
+------------
+
+This document provides guidelines on how to install and configure the RICDMS in various environments/operating modes.
+The audience of this document is assumed to have good knowledge in RIC Platform and Kubernetes.
+
+Software Installation and Deployment
+------------------------------------
+The build process assumes a Linux environment with go >= 1.20  and  has been tested on Ubuntu. For building docker images,
+the Docker environment must be present in the system.
+
+
+Build Process
+~~~~~~~~~~~~~
+
+
+Deployment
+~~~~~~~~~~
+
+
+Testing 
+--------
+
+Unit tests TBD

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..cae9f77
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,9 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020
+
+
+
+
+RICDMS Overview
+====================

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..32ab6f7
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,30 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020
+
+
+Release Notes
+=============
+
+
+This document provides the release notes for the Dawn Release of the HW-go xAPP.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
+
+Summary
+-------
+
+
+Release Data
+------------
+
+
+
+

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..09a0c1c
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
new file mode 100644 (file)
index 0000000..1b9febf
--- /dev/null
+++ b/docs/user-guide.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2021 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2021
+
+============================================================================================ 
+RICDMS
+============================================================================================ 
+-------------------------------------------------------------------------------------------- 
+User's Guide 
+-------------------------------------------------------------------------------------------- 
+ 
+Introduction 
+============================================================================================ 
+
+
+RIDCMS Features 
+============================================================================================ 
+
+