Add release file for it-otf-service-api:0.0.1
[it/otf.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 ..
4 .. Copyright (C) 2019 AT&T Intellectual Property
5
6
7 User Guide
8 ==========
9
10 This is the user guide of OSC <COMPONENT>.
11
12 .. contents::
13    :depth: 3
14    :local:
15
16 ..  a user guide should be how to use the component or system; it should not be a requirements document
17 ..  delete this content after edittng it
18
19
20 Description
21 -----------
22 .. Describe the traget users of the projcet, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc
23 .. Descirbe how the target users can get use of a O-RAN SC component.
24 .. 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?
25
26 Feature Introduction
27 --------------------
28 .. 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.
29
30
31
32     
33