Skip to content
This repository has been archived by the owner on Jun 7, 2022. It is now read-only.

Automate microservice README updates #8

Open
mycognosist opened this issue Nov 4, 2020 · 0 comments
Open

Automate microservice README updates #8

mycognosist opened this issue Nov 4, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mycognosist
Copy link
Contributor

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).

@mycognosist mycognosist added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2020
@mycognosist mycognosist self-assigned this Nov 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant