Update 'new document type'
parent
2b25423a76
commit
53cb51904a
@ -1 +1,26 @@
|
|||||||
Welcome to the Wiki.
|
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
|
Loading…
x
Reference in New Issue
Block a user