.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+
+
+API-Docs
+========
+
+This is the API-docs of <COMPONENT>
+
.. contents::
:depth: 3
:local:
-API-docs
-========
-
.. note
.. This section is used to describe a software API exposed from a O-RAN software component.
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. contents::
- :depth: 3
- :local:
-
Developer-Guide
===============
+.. contents::
+ :depth: 3
+ :local:
.. note:
.. * This section is used to describe what a contributor needs to know in order to work on the componenta
Welcome to O-RAN SC your_repo Documentation
===========================================
-
.. toctree::
:maxdepth: 2
:caption: Contents:
api-docs.rst
-.. toctree::
- :maxdepth: 2
* :ref:`genindex`
* :ref:`modindex`
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+
+
+Installation Guide
+==================
+
.. contents::
:depth: 3
:local:
-Installation guide
-==================
-
Abstract
--------
.. note:any preperation you need before setting up sotfware and hardware
-Hardware requirements
+Hardware Requirements
---------------------
.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
-Software installation and deployment
+Software Installation and Deployment
------------------------------------
.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-..please write your project (repo) overview, better state the relationship with O-RAN alliance.
+..please write your project overview
..please delete this content after editing
your_repo Overview
-==================
+======================
.. http://creativecommons.org/licenses/by/4.0
-Release-notes
+Release-Notes
=============
-Feature additions
+Feature Additions
^^^^^^^^^^^^^^^^^
<STATE ADDED FEATURES BY REFERENCE TO JIRA>
| | |
+--------------------------------------+--------------------------------------+
-Bug corrections
+Bug Corrections
^^^^^^^^^^^^^^^
**JIRA TICKETS:**
Deliverables
^^^^^^^^^^^^
-Software deliverables
+Software Deliverables
+++++++++++++++++++++
<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-Documentation deliverables
+Documentation Deliverables
++++++++++++++++++++++++++
<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-Known issues
+Known Issues
^^^^^^^^^^^^
<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
.. (c) <optionally add copywriters name>
-user guide
+User Guide
==========
+This is the user guide of OSC <COMPONENT>.
+
.. contents::
:depth: 3
:local:
.. Descirbe how the target users can get use of a O-RAN SC component.
.. If the guide contains sections on third-party tools, is it clearly stated why the O-RAN-OSC platform is using those tools? Are there instructions on how to install and configure each tool/toolset?
-Feature introduction
+Feature Introduction
--------------------
.. Provide enough information that a user will be able to operate the feature on a deployed scenario. content can be added from administration, management, using, Troubleshooting sections perspectives.