Skip to content

Generating Component Docs without the full toolchain installed

Jesse Szwedko edited this page Jul 10, 2024 · 2 revisions

If any changes are made to the component docs it is necessary to run:

make generate-component-docs

to generate the associated cue files that are use to build the documentation for the vector.dev site.

This requires a number of components to be installed. To run this in docker to avoid installing all these components locally run:

docker run --rm --user "root:root"  -v "$PWD":/usr/src/myapp -w /usr/src/myapp rust:1.73.0 bash -c 'rm -rf /var/lib/dpkg/lock-frontend && apt update && apt install -y protobuf-compiler libsasl2-dev ruby golang && go install cuelang.org/go/cmd/[email protected] && export PATH="$PATH:/root/go/bin" &&  make generate-component-docs'

(Thanks to @RichardoC for coming up with this)