From be6eb3e02179711e07f46b2d8dc9fed24772e4ed Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Wed, 19 Apr 2023 15:59:07 +0000 Subject: [PATCH] Update 'new document type' --- new-document-type.md | 41 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/new-document-type.md b/new-document-type.md index 772895f..3f6edcb 100644 --- a/new-document-type.md +++ b/new-document-type.md @@ -23,11 +23,44 @@ To delivery new document type the following steps need to be taken: 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 + python3 generate_doc_confpy.py --update-tox --service-type obs --target-environment internal --work-dir ~/test81 ``` - Branch confpyt will be autocreated but in general there will be chicken and egg problem see step4 + Branch confpyt will be autocreated. - 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. 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 \ No newline at end of file + 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 + +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 + +6. 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 + ```