search

stolostron / ansible-collection.core

OCM/ACM Ansible Collection
Apache License 2.0
19 stars 13 forks source link

Generate RST Docs #99

Closed nathanweatherly closed 2 years ago

nathanweatherly commented 2 years ago

RST docs should be the basis of our README(s) for the collection.

Include re-generation of the RST docs in our CI as a github action

nathanweatherly commented 2 years ago

Discussed at scrum:

For doc generation as part of a github action -> With every PR, generate docs to see if there is a difference in the resulting readme. If yes, commit change. Else, don't commit anything.

tl;dr: attempt to update doc with each PR

hanqiuzh commented 2 years ago

Did some investigation on possibility of pushing a commit for the PR, but found difficulties of giving write permissions. As our PRs are from forked repo, and it will be a security issue if it has any write permission. This is actually good.

Currently we are having a github action which supports manual/scheduled doc update (shcedule still needs some tests)

hanqiuzh commented 2 years ago

closing as PR of rst docs got merged, and I will open new issue if the scheduling doesn't work as expected