Update 'new document type'

Hasko, Vladimir 2023-04-19 15:46:06 +00:00
parent 2d26a3ed46
commit 611fbe42a3

@ -1,6 +1,7 @@
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/
@ -10,16 +11,23 @@ To delivery new document type the following steps need to be taken:
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. 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