From 53cb51904ac13df74c33bf538323b57caf7e7a1b Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Fri, 10 Feb 2023 11:06:14 +0000 Subject: [PATCH] Update 'new document type' --- new-document-type.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/new-document-type.md b/new-document-type.md index 5d08b7b..aa43b53 100644 --- a/new-document-type.md +++ b/new-document-type.md @@ -1 +1,26 @@ -Welcome to the Wiki. \ No newline at end of file +To delivery new document type the following steps need to be taken: + + 1. update services.yaml in otc-metadata repository with the following structure: + ``` + - hc_location: api/dcs + 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 + ``` + Consequentially create PR with changed content in doc-exports repo + 3. + 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 + ``` + 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) + 5. do a recheck on target doc repository PR \ No newline at end of file