infra/otc-metadata
14
0
Fork 13
Code Issues 5 Pull Requests Packages Releases Wiki Activity

Update 'new document type'

Hasko, Vladimir
2023-04-19 15:59:07 +00:00
parent 41ba0cd6f5
commit be6eb3e021
1 changed files with 37 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
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: 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 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
```