balena-io-experimental / base-images-docs-generator

Base Images documentation generator

A series of tools to aid in autogenerating documentation for the base images section of the balena documentation. This documentation should be generated on merge in the base images repo and then dynamically brought into the docs site at build time, so this is a temporary solution to get the docs up to date.

Base Image List

Generates the full base images listings. Uses the base contracts to generate the listings.

python3 base-images-ref.py > output/base-images-ref.md

Once output, copy the resulting file to /pages/reference/base-images/base-images-ref.md on the docs repo. Then build and check for broken links using npm broken link checker e.g.

blc --get --input http://localhost:3000/docs/reference/base-images/base-images-ref/ > base-images-ref.md

Followed by cat base-images-ref.md | grep "BROKEN" to identify any broken links.

Machine names and architectures

Generates this listing of machine names and architectures from the base contracts.

python3 machine-names.py > output/machine-names.md

Once output, copy the resulting output to /shared/deviceTypeNames.md on the docs repo. Then build and check for broken links:

blc --get --input http://localhost:3000/docs/reference/base-images/devicetypes/ > device_types.md

Followed by cat device-types.md | grep "BROKEN" to identify broken links.

Balena base images

A quick helper script to output latest and all version information to update the text on the base images overview page. #TODO restructure that page to apply updates automatically.

python3 base-images.py