vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/README.md
Artem Goncharov d4de57a7f4
add zuul jobs (#1) 
Enable zuul jobs

Reviewed-by: OpenTelekomCloud Bot <None>
Reviewed-by: Vladimir Hasko <vladimirhasko@gmail.com>
2022-05-03 05:20:12 +00:00

1.1 KiB
Raw Blame History

doc-exports

Repository to track document exports, not for public use

Document sources (in HTML) are placed under docs//

In the there are files docs_.yaml that describe required data for the particular document. For all of the documents configured in those files conversion from HTML to RST will be attempted. In addition to that a patch file (changes in the RST format) will be generated.

Automatic pull request proposal

Change for any of the documents configured in the docs_.yaml would trigger job to propose corresponding changes to the target repository. This is implemented in the following way:

  • HTML content from the pull request will be converted with the latest conversion script (otc_doc_convertor) to RST (new)

  • HTML content for the same document from current main branch with the corresponding version of the conversion script will be converted to RST (base).

  • New state is compared against base and corresponding patch file is generated

  • Resulting patch file is force-applied in the target repository (skipping all conflicts) and PR is created