iver-wharf / wharf-helm

Deploy Wharf to Kubernetes using Helm
MIT License
0 stars 0 forks source link

Use helm-docs syntax on comments #10

Closed applejag closed 3 years ago

applejag commented 3 years ago

https://github.com/norwoodj/helm-docs uses a particular syntax for its comments. Like this:

controller:
  # -- Configure the healthcheck for the ingress controller
  livenessProbe:
    httpGet:
      # -- This is the liveness check endpoint
      path: /healthz
      port: http

The double dash -- is very important. We need to add this to group the settings appropriately, as since #8 they are a bit jumbled.