Rebuild Documentation for OSC E release
Initial Documentation is already available. This task refers to small updates
Once the OSC E branch is created, the documentation artifacts on that branch need small updates to point to refer to OSC E versions, tags, OSC E-specific links, Release notes, Readmes etc.
Rebuild Documentation for OSC E release:
OSC API documentation
- Make sure the API document is a html file or any other format that can be visited as a web link.
- When an HTML-page with the documentation has been created, a link to it should be added to the following page: https://wiki.o-ran-sc.org/display/DOC/API+document+information+collection+page
Wiki - https://wiki.o-ran-sc.org/display/RICNR/Release+E
- Create a wiki page for Release E – Build
- Create a wiki page for Component configuration
- Create a wiki page for Configuration of Certs
- Create a wiki page for Release E – Run
- Check the version and Gateway
- Check the Run images
- Create a wiki page for Testing End to End call in release D
- Update the Operations and Management wiki
Readthedocs - https://docs.o-ran-sc.org/en/latest/projects.html#non-realtime-ran-intelligent-controller-nonrtric
More detailed function documentation can be found as follow:
- Update the A1 Interface Simulator - https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/index.html
- Update the Non-RT RIC Components - https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/index.html
- Update the Non-RT RIC Control Panel - https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/latest/index.html
Readme & .rst documentation
- Walkthrough the read me
- Walkthrough the .rst
- relates to
-
NONRTRIC-923 NONRTRIC I-Release Epic: Documentation for OSC I release
- In Progress
-
NONRTRIC-855 NONRTRIC H-Release Epic: Documentation for OSC H release & H Maintenance Release
- Done