Skip to content
Snippets Groups Projects
Commit 2ca62266 authored by Sören Henning's avatar Sören Henning
Browse files

Add example command for building crdoc in Docker

parent 344a438d
No related branches found
No related tags found
1 merge request!164Add Theodolite docs
Pipeline #5655 passed
Stage: build
    Stage: test
      Stage: check
        Hide whitespace changes
        Inline Side-by-side
        Showing
        with 7 additions and 1 deletion
        docs/README.md
        + 7
        − 1
        View file @ 2ca62266
        ...@@ -30,8 +30,14 @@ bundle exec jekyll build ...@@ -30,8 +30,14 @@ bundle exec jekyll build
        ## CRD API Reference ## 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 ```sh
        crdoc --resources ../theodolite/crd/ --output api-reference/crds.md 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"
        ```
        0% or .
        You are about to add 0 people to the discussion. Proceed with caution.
        Finish editing this message first!
        Please register or to comment