Update README.md #92
Update README.md #92
Conversation
|
Thanks @TomAugspurger. We use Frigate here for autogenerating the README. The main benefit is that it keeps the table of configuration options up to date. Would you mind updating the template and regenerating the REAMDE? https://github.com/dask/helm-chart#generating-the-readme (I made some changes to Frigate this week which will make it super useful for daskhub as it will pull all the possible configuration options from the dependency charts too) |
|
This whole process of using a template and generating the README from it is a little annoying. Frigate also has a sphinx plugin so we may just want to move the docs to RTD instead of the README to make the whole experience more pleasant. |
dask/README.md
Outdated
| @@ -65,7 +65,7 @@ The following table lists the configurable parameters of the Dask chart and thei | |||
| | `scheduler.image.pullPolicy` | Container image pull policy. | `"IfNotPresent"` | | |||
| | `scheduler.image.pullSecrets` | Container image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). | `null` | | |||
| | `scheduler.replicas` | Number of schedulers (should always be 1). | `1` | | |||
| | `scheduler.serviceType` | Scheduler service type. set to `loadbalancer` to expose outside of your cluster. | `"ClusterIP"` | | |||
| | `scheduler.serviceType` | Scheduler service type. set to `LoadBalancer` to expose outside of your cluster. | `"ClusterIP"` | | |||
There was a problem hiding this comment.
This may be a bug in Frigate because the comment in the values.yaml this is generated from looks correct.
https://github.com/dask/helm-chart/blob/master/dask/values.yaml#L14
There was a problem hiding this comment.
If I had to guess it's https://github.com/rapidsai/frigate/blob/874493d8fbfd8c7fe94f13a709bcf7bf92cc680b/frigate/gen.py#L184.
I think it'd be best if frigate didn't try to be clever here. What do you think?
There was a problem hiding this comment.
Yeah I think dropping the capitalise call would be best.
As noted in dask/helm-chart#92 (comment), in some comments capitalization is important so frigate shouldn't change it.
As noted in dask/helm-chart#92 (comment), in some comments capitalization is important so frigate shouldn't change it.
I believe these docs were out of date.