[Docs] Make mlrun-kit the main installation option #590
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gilad-shaham
force-pushed
the
doc_install_update
branch
from
d048052
to
9be65cd
Compare
Hedingber
suggested changes
Dec 15, 2020
README.md
Outdated
| @@ -71,7 +91,7 @@ pip install mlrun | |||
| MLRun requires separate containers for the API and the dashboard (UI). | |||
| You can also select to use the pre-baked JupyterLab image. | |||
|
|
|||
| To install and run MLRun locally using Docker or Kubernetes, see the instructions in [**hack/local/README.md**](hack/local/README.md). | |||
| To install and run MLRun locally using Docker or Kubernetes, see the instructions in the [**MLRun documentation**]([hack/local/README.md](https://mlrun.readthedocs.io/en/latest/install.html)). | |||
There was a problem hiding this comment.
The new link doesn't work, looks like a typo
README.md
Outdated
| - [Using the MLRun CLI](#run-mlrun-service-cli) | ||
| - [Benefits](#benefits) | ||
| - [Components](#components) | ||
| - [In This Document](#in-this-document) |
There was a problem hiding this comment.
In this document seems unrelated as a sub-title of components suggest to return it to the top as before plus changing it from #### to ##
docs/install.md
Outdated
|
|
||
| Create a namespace for mlrun. For example: | ||
| To install the chart with the release name `my-mlrun` use the following command. |
There was a problem hiding this comment.
I would have rename my-mlrun to mlrun-kit
no functional change just feels more professional IMO
this is just a suggestion, you don't have to take it
docs/install.md
Outdated
| helm install -n mlrun nfsprov stable/nfs-server-provisioner | ||
| #### Set Environment Variables | ||
|
|
||
| Define your MLRun configuration. As a minimum requirement — |
There was a problem hiding this comment.
the — is on purpose ?
There was a problem hiding this comment.
fixed (also in remote.md)
Hedingber
changed the title
Hedingber
approved these changes
Dec 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.