From: weichen <niweichen@chinamobile.com>
Date: Wed, 6 Nov 2019 07:52:29 +0000 (-0500)
Subject: make all titles in the same format
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=f0de3c3f323b8dc65bf4a662cf22692576ca105b;p=doc.git

make all titles in the same format

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

diff --git a/doc-templates/api-docs.rst b/doc-templates/api-docs.rst
index 6ccc6e4..b7fde67 100644
--- a/doc-templates/api-docs.rst
+++ b/doc-templates/api-docs.rst
@@ -1,13 +1,17 @@
 .. 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.  
diff --git a/doc-templates/developer-guide.rst b/doc-templates/developer-guide.rst
index 4707804..0d1f6e0 100644
--- a/doc-templates/developer-guide.rst
+++ b/doc-templates/developer-guide.rst
@@ -1,13 +1,12 @@
 .. 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
diff --git a/doc-templates/index.rst b/doc-templates/index.rst
index e3901b3..b209a29 100644
--- a/doc-templates/index.rst
+++ b/doc-templates/index.rst
@@ -5,7 +5,6 @@
 Welcome to O-RAN SC your_repo Documentation
 ===========================================
 
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -18,8 +17,6 @@ Welcome to O-RAN SC your_repo Documentation
    api-docs.rst
 
 
-.. toctree::
-   :maxdepth: 2
 
 * :ref:`genindex`
 * :ref:`modindex`
diff --git a/doc-templates/installation-guide.rst b/doc-templates/installation-guide.rst
index fd961e8..2412acf 100755
--- a/doc-templates/installation-guide.rst
+++ b/doc-templates/installation-guide.rst
@@ -1,13 +1,15 @@
 .. 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
 --------
 
@@ -55,7 +57,7 @@ Before starting the installation of <project name>, some planning must preceed.
 .. 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>
 
@@ -88,7 +90,7 @@ Following minimum hardware requirements must be met for installation of <project
 
 
 
-Software installation and deployment
+Software Installation and Deployment
 ------------------------------------
 .. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
 
diff --git a/doc-templates/overview.rst b/doc-templates/overview.rst
index 36434f2..f29301e 100644
--- a/doc-templates/overview.rst
+++ b/doc-templates/overview.rst
@@ -1,6 +1,6 @@
-..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
-==================
+======================
diff --git a/doc-templates/release-notes.rst b/doc-templates/release-notes.rst
index ceb4bf8..0359af4 100644
--- a/doc-templates/release-notes.rst
+++ b/doc-templates/release-notes.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 
-Release-notes
+Release-Notes
 =============
 
 
@@ -65,7 +65,7 @@ Release Data
 
 
 
-Feature additions
+Feature Additions
 ^^^^^^^^^^^^^^^^^
 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
 
@@ -86,7 +86,7 @@ Feature additions
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-Bug corrections
+Bug Corrections
 ^^^^^^^^^^^^^^^
 
 **JIRA TICKETS:**
@@ -107,14 +107,14 @@ Bug corrections
 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>
@@ -131,7 +131,7 @@ System Limitations
 
 
 
-Known issues
+Known Issues
 ^^^^^^^^^^^^
 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 
diff --git a/doc-templates/user-guide.rst b/doc-templates/user-guide.rst
index ed4d58b..989f319 100755
--- a/doc-templates/user-guide.rst
+++ b/doc-templates/user-guide.rst
@@ -3,9 +3,11 @@
 .. (c) <optionally add copywriters name>
 
 
-user guide
+User Guide
 ==========
 
+This is the user guide of OSC <COMPONENT>.
+
 .. contents::
    :depth: 3
    :local:
@@ -20,7 +22,7 @@ Description
 .. 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.