...
- The list of repos that are to be included in Amber release under your project.
- For each repo, provide the following information:
- License Status:
- What license for each repo, Apache 2 or O-RAN?
- Whether the LICENSES.txt is included at the root of the repo and whether each code file has a license and copyright claim header?
- NOT including any contributing company proprietary information?
- Code status:
- Is the code available (code MUST be in by code freeze date of 11/04)?
- Is the code build-able?
- Is the building and artifact generation integrated with LF Jenkins? We can mark this item as "yes" if a particular repo implements a (a) verify, (b) merge and (c) daily release job. The group maintaining a repo needs to implement this.
- Documentation status:
- Following the documentation format, structure, and template provided by DOC project?
It is sufficient to generate the release notes bases on docs/release-notes.rst in your repo as per https://wiki.o-ran-sc.org/display/DOC#DocumentationHome-RequiredFiles ans as per these templates https://wiki.o-ran-sc.org/display/DOC#DocumentationHome-Templates Other files you may also generate already now if you think this can be done in the remaining Amber timeframe (deadline = Nov-13, 8am ET): docs/installation-guides.rst, docs/developer-guide.rst , docs/api-docs.rst. The file docs/index.rst is also needed as. For Amber release the minimum requirement is the release note file. There is no need to publish README.md file from your repo in readthedocs.io . We need to figure out a clever way to maintain it in the root directory (for github& co), but also to correctly trigger the general CI job that generates documentation. You pass this item (2.c.ii) if you can successfully run "tox -e docs,docs-linkcheck" on your repo/subproject and it generates HTML that includes release notes.
- Documentation buildable by the DOC project?
- Also implement the input for the centralized Jenkins job that pushes the documentation to readthedocs.io (https://readthedocs.org/projects/o-ran-sc-doc/ (scroll down to see "Sub projects" on the right hand side)). Instructions on how to publish them to via thus centralized Jenkins job are here: Configure Repo for Documentation. (the doc-template directory under the doc repo already contains all the necessary files).
- Prepared a video demo for how to build and run your project.
- Following the documentation format, structure, and template provided by DOC project?
Documentation Home:
https://docs.o-ran-sc.org/en/latest/
Status
(Near Realtime) RICAPP
...