Update 'new document type'

Hasko, Vladimir 2023-04-19 16:03:32 +00:00
parent e3dc8ae3b1
commit bd33ac1741

@ -2,29 +2,29 @@ To delivery new document type the following steps need to be taken:
1. update services.yaml in otc-metadata repository with the following structure (sorted by service_type+title): 1. update services.yaml in otc-metadata repository with the following structure (sorted by service_type+title):
``` ```
- html_location: docs/dcs/api-ref - html_location: docs/dcs/api-ref
link: /distributed-cache-service/api-ref/ link: /distributed-cache-service/api-ref/
pdf_name: dcs-api-ref pdf_name: dcs-api-ref
rst_location: api-ref/source rst_location: api-ref/source
service_type: dcs service_type: dcs
title: API Reference title: API Reference
type: api-ref type: api-ref
``` ```
2. Generate updated metadata.yaml in the doc-exports repository with tools/generate_docexports_data.py: 2. 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 python tools/generate_docexports_data.py > ../../docs/doc-exports/metadata.yaml
``` ```
Consequentially create PR with changed content in doc-exports repo 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: 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 python3 generate_doc_confpy.py --update-tox --service-type obs --target-environment internal --work-dir ~/test81
``` ```
Branch confpyt will be autocreated. Branch confpyt will be autocreated.