Page History

...

1. Copy folders and files from product's folder in the nonrtric repo. Things to copy, if they exist, e.g.:
   1. "src" folder
   2. "api" folder
   3. "config" folder
   4. Dockerfile
   5. eclipse-formatter.xml
   6. pom.xml
   7. README.md
   8. tox.ini
   9. .readthedocs.yaml
2. Remove For Java projects, remove ".nonrtric" from the "groupId" tag in the pom file.
3. For Java projects, change the name of the product and change the image name in the "docker-maven-plugin" configuration in the pom file.
4. For Go projects, copy the "build-<product name>-ubuntu.sh", "container-tag.yaml", and "generate_swagger_docs.sh" (if it exists) files. Adapt the paths in the files to fit the new project structure.
5. Copy the top level ".gitignore" file from the "nonrtric" repo and add the content of the ".gitignore" file in the original product's folder.
6. Create a folder named "docs" in the new repo.
7. Copy the "docs/images" folder to the docs folder of the new repo, and remove images that are not used in the product's documentation.
8. Copy the "docs/_static" folder to the docs folder of the new repo.
9. Copy the "docs/conf.py" file to the docs folder of the new repo. Edit it, and from the "linkcheck_ignore" remove the paths not relevant for the product. Also remove unused things from the "redoc" part and any unused "intersphinx_mapping".
10. Copy the "docs/conf.yaml" file to the docs folder of the new repo. Edit it and change the "project" to fit the name of the product.
11. Copy the "docs/favicon.ico" to the docs folder of the new repo.
12. Copy the "requirements-docs.txt" to the docs folder of the new repo.
13. Copy all the "rst" files, except for "use-cases.rst" and "requirements.rst" to the docs folder of the new repo.
14. Remove "./use-cases.rst" and "./requirements.rst" from the "index.rst" file.
15. Adapt the paths to the Swagger generated api files in "conf.py" and "api-docs.rst". Example: "../r-app-catalogue/api/rac-api.json" should be "../api/rac-api.json".
16. Go through and adapt or remove all the other "rst" files to fit the product. Remember to update the "index.rst" file for all removed files. Run a search for the product's name in all files to see if anything more needs fixing, "grep -rnw '.' -e 'r-app-catalogue'".
17. Adapt paths in Docker files if needed.
18. Build the documentation from the top level with the command "tox". Fix any problems that might arise.
19. Build the project and fix any problems that might arise:
    For Java projects: Run "mvn install" from the top level.
    For Go projects: Run "go build", "go test ./...", and "docker build".
20. Stage everything, commit and push to Nordix and upstream.
21. Make sure the " rtdv3-global-verify-master" job that verifies the readthedocs is successful in Gerrit in o-ran-sc.

...