Document Generation for Microservices

Generates documentation by pulling latest README.md files and aggregating all endpoint information into a single file. This file is then used by Slate to build a Docker image and deployed as per the CircleCI config.

Usage

Create/update a repo which includes a file specifying endpoint usage:
- Format endpoints section similarly to the Slate docs example which generates https://slatedocs.github.io/slate.
- Ensure that the Endpoints section is clearly identified, either with the default identifier and section separator or a custom choice (see below).

Add repo and file details to repos array in generation config file.

NOTE: url and path must point to raw file.
e.g.

    [[repos]]
    url = "https://raw.githubusercontent.com/<org>/<repo>/<branch>/"
    path = "README.md"
    section_separator = '\n## '         # optional        
    endpoints_identifier = 'Endpoints'  # optional

Add Github action to trigger Docker image rebuild on push to repo, eg. .github/workflows/circleci-doc-gen-workflow.yml

name: Trigger Doc Generation CircleCi job

on:
push:
    branches:
        - master

jobs:
curl:
    runs-on: ubuntu-latest
    steps:
    - name: curl
    uses: wei/curl@master
    with:
        args: curl -X POST https://circleci.com/api/v1.1/project/github/SKOOTUK/microservice_api_doc_generator/build?circle-token=${{ secrets.circleci_api_token }}

Get repo added to circleci_api_token on Github organisation secrets
Get deploy key added to repo and CircleCI project SSH keys.