From 2ca622668f05d59f9a229bcc0d979bf8617f9b15 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Fri, 17 Dec 2021 10:15:49 +0100
Subject: [PATCH] Add example command for building crdoc in Docker

---
 docs/README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/README.md b/docs/README.md
index c65d29845..3da3a7d1a 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"
+```
-- 
GitLab