7
Home
tischrei edited this page 2024-02-13 10:12:37 +00:00

Metadata

All changes to any of the doc data is generated from metadata in this repository with the help of scripts:

otc_metadata/data/services.yaml file contains all services, and docs and services sorted alphabetically

  • python tools/generate_docexports_data.py > ../../docs/doc-exports/metadata.yaml is used to generate new metadata.yaml file in the doc-exports repository

  • tools/bootstrap_repositories.py ... is used to create new doc repository

  • otc-metadata$ python tools/bootstrap_repositories.py --target-environment internal --service-type rms --work-dir ~/workspace/

  • switch to new repository, checkout to main branch and push main branch

  • tools/generate_doc_confpy.py - creating PRs to update conf.py file for all docs and option to update local tox.ini

  • tools/generate_doc_gitcontrol_repos.py <path_to_gincontrol>/data/gitXXX/orgs/xxx/ - generate (update) gitcontrol

  • tools/open_doc_issue.py - open gitea issues for every document

  • tools/sync_doc_repo.py - open PRs to synchronize content (overwrite) between environments. gh tool as package needs to be present: https://github.com/cli/cli/blob/trunk/docs/install_linux.md