improving documentation for quickstart #14
Conversation
|
|
||
| ## Requirements | ||
| * kind v0.25.0 or above | ||
| * helm v3.16.3 or above |
There was a problem hiding this comment.
v3.16.3 is just 3 weeks old. I'm using v3.15.4 on my local machine and it works fine. Maybe we can write "tested on v3.15.4 but should work with older versions as well"?
| This guide was created to help new users of Kubeflow install and test Kubeflow Helm Charts locally based on the kind. | ||
|
|
||
| ## Requirements | ||
| * kind v0.25.0 or above |
There was a problem hiding this comment.
v0.25.0 is just a month old, we could definitely run on an older version. Maybe we can write "tested on v0.25.0 but should work with older versions as well"?
| ## Requirements | ||
| * kind v0.25.0 or above | ||
| * helm v3.16.3 or above | ||
| * curl 8.7.1 or above |
There was a problem hiding this comment.
I don't think we need any specific feature of curl. Maybe we can write that just the curl itself is required for quickstart?
| @@ -0,0 +1,45 @@ | |||
| # Kind | |||
| This guide was created to help new users of Kubeflow install and test Kubeflow Helm Charts locally based on the kind. | |||
There was a problem hiding this comment.
We provide multiple quickstart scripts, I think it would be much better to explain all of the quickstarts. Is this something you could add?
Some other resources you might find helpful in describing other quickstarts:
- https://kromanow94.github.io/kubeflow-manifests/ (it's pretty old but was first explanation of the quickstart scripts and the initiative)
- helm chart kubeflow/kubeflow#3173 (comment)
- helm chart kubeflow/kubeflow#3173 (comment)
- helm chart kubeflow/kubeflow#3173 (comment)
- Helm charts kubeflow/manifests#2730
| $ helm repo update | ||
| ``` | ||
|
|
||
| ## Install |
There was a problem hiding this comment.
It would be great if we could provide explanation of different quickstart options.
|
Hey, as mentioned in the #13 (comment), could you also update the Also, the |
After testing release 0.3.0, I'm sharing some improvements to help other users test the Kubeflow Helm Charts.