From bd33ac1741bc695de45475a99132f7961c224e85 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Wed, 19 Apr 2023 16:03:32 +0000 Subject: [PATCH] Update 'new document type' --- new-document-type.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/new-document-type.md b/new-document-type.md index 7c38fd9..a1d5bae 100644 --- a/new-document-type.md +++ b/new-document-type.md @@ -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): - ``` - - 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 - ``` + ``` + - 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. 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 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.