Automate microservice README updates #8

New Issue

2020-11-04T10:35:56Z

mycognosist commented

2020-11-04 10:35:56 +00:00

(Migrated from github.com)

We want to minimize any discrepancies between the developer documentation Gitbook and the documentation of each individual (micro)service (READMEs). One way to do this is to (partially) automate the process.

I'd like to create Githooks so that the peach-devdocs repo is automatically updated when changes are made to any of the microservice repos. For example, if a change is made to the peach-network README and merged to master, that should result in the Software -> Microservices -> peach-network section of the devdocs being updated (a 1:1 copy of the README). The update of the devdocs should in-turn update the production deployment (docs.peachcloud.org).

The same process should be replicated for the peach-config repo (quick deployment / configuration section of devdocs).

We want to minimize any discrepancies between the developer documentation Gitbook and the documentation of each individual (micro)service (READMEs). One way to do this is to (partially) automate the process. I'd like to create Githooks so that the peach-devdocs repo is automatically updated when changes are made to any of the microservice repos. For example, if a change is made to the peach-network README and merged to master, that should result in the Software -> Microservices -> peach-network section of the devdocs being updated (a 1:1 copy of the README). The update of the devdocs should in-turn update the production deployment (docs.peachcloud.org). The same process should be replicated for the peach-config repo (quick deployment / configuration section of devdocs).

Sign in to join this conversation.