diff --git a/docs/README.md b/docs/README.md index c65d29845358b588eece0caa995fbeb5f8f6e66b..3da3a7d1aa82bc538c7896826ee157264135f62f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,8 +30,14 @@ bundle exec jekyll build ## CRD API Reference -We use the [crdoc](https://github.com/fybrik/crdoc) tool to generate the API reference for our CRDs. +We use the [crdoc](https://github.com/fybrik/crdoc) tool to generate the API reference for our CRDs: ```sh crdoc --resources ../theodolite/crd/ --output api-reference/crds.md ``` + +With the following command, crdoc is installed and executed in Docker: + +```sh +docker run --rm -v "`pwd`/../theodolite/crd/":/crd -v "`pwd`/api-reference":/api-reference golang sh -c "go install fybrik.io/crdoc@latest && crdoc --resources /crd/ --output /api-reference/crds.md" +```