12

new document type

tischrei edited this page 2024-02-27 12:57:35 +00:00

To delivery new document type the following steps need to be taken:

0. if this is completely new document type it should be added also in otc-sphinx-directives repo: https://github.com/opentelekomcloud/otc-sphinx-directives/blob/main/otc_sphinx_directives/service_card.py

1. update services.yaml in otc-metadata repository with the following structure (sorted by service_type+title):

   - html_location: docs/dcs/api-ref
     link: /distributed-cache-service/api-ref/
     pdf_name: dcs-api-ref
     rst_location: api-ref/source
     service_type: dcs
     title: API Reference
     type: api-ref

2. Install latest metadata application. Generate updated metadata.yaml in the doc-exports repository with tools/generate_docexports_data.py:

   python tools/generate_docexports_data.py > ../../docs/doc-exports/metadata.yaml

    Consequentially create PR with changed content in doc-exports repo

3. Generate tox.ini and conf.py for respective document changes with tools/generate_doc-conf.py script:

   python3 generate_doc_confpy.py --update-tox --service-type obs --target-environment internal --work-dir ~/test81

   Branch confpyt will be autocreated.

4. Create PR on confpy but you need to update branch with file .placeholder in _static directory under respective document type

5. do a recheck on target doc repository PR

---

To deploy new document to github (PROD env) proceed with following steps:

1. Remove the parameter

   environment: internal

   from otc-metadata repository on respective document

2. Generate tox.ini and conf.py for respective document changes with tools/generate_doc-conf.py script:

   python3 generate_doc_confpy.py --update-tox --service-type obs --target-environment public --work-dir ~/test82

   Branch confpy will be autocreated

3. Create PR on confpy but you need to update branch with file .placeholder in _static directory under respective document type

4. Do a recheck on target doc repository PR

5. In case the PR on target doc repository is not autocreated by propagate job. Use the following script to initiate initial import of document on github

   python3 ~/otc-metadata/tools/sync_doc_repo.py --source-environment internal --target-environment public --service-type obs --branch-name "sync_19042023" --document-type permissions-configuration-guide --open-pr-gh --work-dir ~/tmpdir49