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

Automate microservice README updates #8

@mycognosist

Description

@mycognosist

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions