Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • support-empty-query-response
  • java-operator-sdk
  • rework-state-handling
  • quarkus-36
  • bump-kotlinlogging-to-5.0.2
  • improve-patcher-documentation
  • use-internal-registry protected
  • v0.9 protected
  • kafka-nodeport-config-windows
  • v0.8 protected
  • test-k3d protected
  • simpleuc4 protected
  • reduce-code-duplication
  • test-coverage
  • code-cleanup
  • cleanup-commit-interval protected
  • delete-action-for-other-namespace
  • master protected
  • add-helm-test-debug2
  • v0.9.0 protected
  • v0.8.6 protected
  • v0.8.5 protected
  • v0.8.4 protected
  • v0.8.3 protected
  • v0.8.2 protected
  • v0.8.1 protected
  • v0.8.0 protected
  • v0.7.0 protected
  • v0.5.2 protected
  • v0.6.4 protected
  • v0.6.3 protected
  • v0.6.2 protected
  • v0.6.1 protected
  • v0.6.0 protected
  • v0.5.1 protected
  • v0.5.0 protected
  • v0.4.0 protected
  • v0.3.0 protected
  • v0.2.0 protected
40 results

docs

  • Clone with SSH
  • Clone with HTTPS
  • Theodolite Docs

    Theodolite's docs are generated with Jekyll from Markdown files.

    Installation

    To set up Jekyll run:

    gem install bundler
    bundle config set --local path 'vendor'
    bundle install

    Local Testing

    For live serving the docs run:

    bundle exec jekyll serve

    Building

    You can compile everything to HTML via:

    bundle exec jekyll build

    CRD API Reference

    We use the crdoc tool to generate the API reference for our CRDs:

    crdoc --resources ../theodolite/crd/ --template api-reference/crds.tmpl  --output api-reference/crds.md

    With the following command, crdoc is executed in Docker:

    docker run --rm -v "`pwd`/../theodolite/crd/":/crd -v "`pwd`/api-reference":/api-reference ghcr.io/fybrik/crdoc:0.6.1 --resources /crd/ --template /api-reference/crds.tmpl --output /api-reference/crds.md