| Aric Gardner | 9ad5c04 | 2019-10-22 13:42:10 -0400 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| Lott, Christopher (cl778h) | e706e85 | 2019-11-08 10:10:17 -0500 | [diff] [blame] | 2 | .. SPDX-License-Identifier: CC-BY-4.0 |
| 3 | .. Copyright (C) 2019 YOUR-ORGANIZATION-NAME |
| Aric Gardner | 9ad5c04 | 2019-10-22 13:42:10 -0400 | [diff] [blame] | 4 | |
| weichen | 300706e | 2019-11-04 10:13:57 -0500 | [diff] [blame] | 5 | |
| weichen | f0de3c3 | 2019-11-06 02:52:29 -0500 | [diff] [blame] | 6 | User Guide |
| weichen | 300706e | 2019-11-04 10:13:57 -0500 | [diff] [blame] | 7 | ========== |
| 8 | |
| weichen | f0de3c3 | 2019-11-06 02:52:29 -0500 | [diff] [blame] | 9 | This is the user guide of OSC <COMPONENT>. |
| 10 | |
| Aric Gardner | 9ad5c04 | 2019-10-22 13:42:10 -0400 | [diff] [blame] | 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 |
| weichen | 300706e | 2019-11-04 10:13:57 -0500 | [diff] [blame] | 20 | ----------- |
| Aric Gardner | 9ad5c04 | 2019-10-22 13:42:10 -0400 | [diff] [blame] | 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 | |
| weichen | f0de3c3 | 2019-11-06 02:52:29 -0500 | [diff] [blame] | 25 | Feature Introduction |
| weichen | 300706e | 2019-11-04 10:13:57 -0500 | [diff] [blame] | 26 | -------------------- |
| Aric Gardner | 9ad5c04 | 2019-10-22 13:42:10 -0400 | [diff] [blame] | 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 | |