doc: Update quickstart.md #398
Conversation
kserve#366 (comment) Signed-off-by: AshleyZhao <[email protected]>
There was a problem hiding this comment.
Thank you @AshleyZhao this doc change will be a good improvement to prevent confusion for anyone who wants to try out ModelMesh for the first time.
I think we need a few more changes though.
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| To quickly get started using ModelMesh Serving, here is a brief guide. | |||
|
|
|||
| > **Note**: To install the latest stable release, please follow the [Quick Start Guide for version 0.11](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md). | |||
There was a problem hiding this comment.
I think this note is good, but we should preface it by saying that the instructions in this guide are for the latest / main branch ("under development").
A bit further down we should change RELEASE=release-0.10 to RELEASE=main and when we draft a release we replace it with the latest new release branch. And add a sentence that this is only necessary of the repo has not been (forked and) cloned yet.
we probably need the same kind of note in other install docs (docs/install/README.md, FVT, ...) where ever we ask to clone the repo and checkout a release-0.10 or release-0.11 branch
There was a problem hiding this comment.
Hi @ckadner,
So sorry for the late response, let me get to your suggestions!
preface it by saying that the instructions in this guide are for the latest / main branch ("under development").
What do you think about adding this sentence:
The following instructions are only for early adopters who want to install the latest ModelMesh release which is under development. To install the latest stable release...
change RELEASE=release-0.10 to RELEASE=main and when we draft a release we replace it with the latest new release branch.
Sounds good, so v0.10 the latest stable release, and I should change the link to Quick Start Guide for version 0.10. And keep it updated somehow in the future. (Perhaps with the usage of conrefs/keydefs...)
we probably need the same kind of note in other install docs (docs/install/README.md, FVT, ...) where ever we ask to clone the repo and checkout a release-0.10 or release-0.11 branch
a. I see README.md already links to the Quick Start Guide at the bottom
b. What do you think of adding this kind of note for FVT docs and other varieties:
The following instructions are only for early adopters who want to install the latest ModelMesh release with Gingko which is under development. To install the latest stable release...
There was a problem hiding this comment.
The following instructions are only for early adopters who want to install the latest ModelMesh release which is under development. To install the latest stable release...
I like this but maybe shorten to The following instructions install the latest ModelMesh release which is under development. To install the latest stable release...
a. I see README.md already links to the Quick Start Guide at the bottom
Just to be clear in case you're referring to this README, I don't think it needs to be changed. I believe @ckadner is referring to the parts of docs such as this one, which include explicit instructions for installation. Here, I believe we would keep it pointed to the latest official release (v0.10.0, soon to be v0.11.0).
There was a problem hiding this comment.
I would go a bit further and remove the notion of "release" for the install from main and keep the term latest for the actual latest code, as in latest tag Docker image, e.g.:
This quick-start guide describes how to install the
latestunreleased version of ModelMesh from the top of themaindevelopment branch. To install the most recent stable release ...
There was a problem hiding this comment.
And the code snippet below:
Get the latest release
RELEASE=release-0.10 git clone -b $RELEASE --depth 1 --single-branch https://github.com/kserve/modelmesh-serving.git cd modelmesh-serving
Needs to be updated to:
Clone the ModelMesh repository
RELEASE=main
git clone -b $RELEASE --depth 1 --single-branch https://github.com/kserve/modelmesh-serving.git
cd modelmesh-serving
|
We need to add additional instructions in the release guide to remove the note of caution and update references of the e.g. here: modelmesh-serving/docs/release-process.md Line 110 in 5d71c59 and here: modelmesh-serving/docs/release-process.md Line 131 in 5d71c59 |
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| To quickly get started using ModelMesh Serving, here is a brief guide. | |||
|
|
|||
| > **Note**: To install the latest stable release, please follow the [Quick Start Guide for version 0.11](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md). | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| - A Kubernetes cluster v 1.16+ with cluster administrative privileges | |||
There was a problem hiding this comment.
K8s version needs to be a minimum of 1.23 now and kustomize version actually needs to be 4.0 and up
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| To quickly get started using ModelMesh Serving, here is a brief guide. | |||
|
|
|||
| > **Note**: To install the latest stable release, please follow the [Quick Start Guide for version 0.11](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md). | |||
There was a problem hiding this comment.
And the code snippet below:
Get the latest release
RELEASE=release-0.10 git clone -b $RELEASE --depth 1 --single-branch https://github.com/kserve/modelmesh-serving.git cd modelmesh-serving
Needs to be updated to:
Clone the ModelMesh repository
RELEASE=main
git clone -b $RELEASE --depth 1 --single-branch https://github.com/kserve/modelmesh-serving.git
cd modelmesh-serving
There was a problem hiding this comment.
Thanks @AshleyZhao, let's merge this PR and do the remaining changes in a separate one (#414)
/lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: AshleyZhao, ckadner The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Add note to Quick Start Guide with link to the last stable release. Signed-off-by: AshleyZhao <[email protected]> (cherry picked from commit 79aa2ae)
#366 (comment)
Motivation
Add note to Quick Start Guide for link to the last stable release.
Modifications
Added note in the main Quick Start Guide as agreed by comment.
Result