Merge "Add support for generating documentation for smo/o1"
[smo/o1.git] / docs / user-guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) <optionally add copywriters name>
4
5
6 User Guide
7 ==========
8
9 This is the user guide of OSC <COMPONENT>.
10
11 .. contents::
12    :depth: 3
13    :local:
14
15 ..  a user guide should be how to use the component or system; it should not be a requirements document
16 ..  delete this content after edittng it
17
18
19 Description
20 -----------
21 .. Describe the traget users of the projcet, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc
22 .. Descirbe how the target users can get use of a O-RAN SC component.
23 .. 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?
24
25 Feature Introduction
26 --------------------
27 .. 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.
28
29
30
31     
32