From 41ba0cd6f54add683c449cdf0aeeaa57c01d2f81 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Wed, 19 Apr 2023 15:47:18 +0000 Subject: [PATCH] Update 'new document type' --- new-document-type.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/new-document-type.md b/new-document-type.md index 48c96cc..772895f 100644 --- a/new-document-type.md +++ b/new-document-type.md @@ -1,6 +1,6 @@ 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 @@ -12,7 +12,7 @@ To delivery new document type the following steps need to be taken: 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 @@ -20,7 +20,7 @@ To delivery new document type the following steps need to be taken: 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 public --work-dir ~/test81 @@ -28,6 +28,6 @@ To delivery new document type the following steps need to be taken: Branch confpyt will be autocreated but in general there will be chicken and egg problem see step4 - 4. Either update existing doc PR with the changes on conf.py and tox.ini (easier) or create PR on confpy but you need to update branch also with some default structure/placeholders and index to have successful job (a bit more complex) + 4. Either update existing doc PR with the changes on conf.py and tox.ini (easier) or create PR on confpy but you need to update branch also with some default structure/placeholders and index to have successful job (a bit more complex) - 5. do a recheck on target doc repository PR \ No newline at end of file + 5. do a recheck on target doc repository PR \ No newline at end of file