benwilcock/systems-techdocs

The repo contains some sample Backstage TechDocs documentation for the Where For Dinner sample application.

Systems TechDocs

This repo helps me build and publish technical documentation for a collection of Backstage "Systems".

The Dockerfile creates an image based on Spotify/Techdocs and adds a script called generateAndPublish.sh as the entrypoint.

To build the techdocs image run:

docker build . -t techdocs --no-cache

When called during a docker run of the techdocs image, the above script can build the techdocs and publish them to an AWS bucket (using creds in the .env file). The command line for this looks something like this...

docker run --rm --env-file .env -v ./:/tmp/catalog/ techdocs /tmp/catalog/catalog-info.yaml awsS3 tap-techdocs

The catalog-info.yaml in the root of this repo is used as a signpost to say which techdocs the script should attempt to build and publish.

Once you have built the techdocs image, you can use it anywhere you have a similar catalog-info.yaml file.