Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note to install docs to use doc for latest released version #366

Closed
ckadner opened this issue May 5, 2023 · 5 comments
Closed

Add note to install docs to use doc for latest released version #366

ckadner opened this issue May 5, 2023 · 5 comments
Assignees
Labels
development documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ckadner
Copy link
Member

ckadner commented May 5, 2023

We need to figure out a better way to handle these cross-version changes, like adding a note with a link at the top of the Quickstart Guide (and other install docs) to point users to the last released version of the document and reserve the main version for developers and early adopters who do not need to clone the last release ...

We had this problem several times before when we updated the Quickstart Guide for the kustomize version compatibility, ClusterServingRuntime, and namespace-scope mode.

@rafvasq @tjohnson31415 @njhill

Originally posted by @ckadner in #364 (comment)

@ckadner ckadner added documentation Improvements or additions to documentation good first issue Good for newcomers development labels May 5, 2023
@AshleyZhao
Copy link
Contributor

Can I take on this issue? Thanks

@rafvasq rafvasq assigned rafvasq and AshleyZhao and unassigned rafvasq May 30, 2023
@rafvasq
Copy link
Member

rafvasq commented May 30, 2023

Sure @AshleyZhao, let us know if you need any more clarification

@AshleyZhao
Copy link
Contributor

Hi @rafvasq,

Sorry I hadn't been able to get back to you for some time. I have some minor questions about the note I'm trying to add and thought a comment would be the best place.

a. Do you prefer links to the earlier releases such as:

Tip or Attention or Info or Note: If you are working with a specific version of ModelMesh and not in a development environment, use one of the following guides:

b. Do you prefer the note to be more descriptive:

Tip or Attention or Info or Note: If you are working with a specific version of ModelMesh and not in a development environment, switch to an earlier version of this document by selecting the appropriate Git branch.

Lmk of any other improvements I can make!

(Also I think this will impact more than one file, but for my PR will be just for one file for now.)

Thanks in advance.

@rafvasq
Copy link
Member

rafvasq commented Jun 15, 2023

Hey @AshleyZhao, I think the idea here is something like the first but only including the link to the latest release. For the quickstart, maybe it would look like

Note: To install the latest stable release, please follow the quickstart guide for v0.11 .

@ckadner please feel free to disagree or add anything else you'd like to be done here!

AshleyZhao pushed a commit to IBMDataScience/modelmesh-serving that referenced this issue Jun 15, 2023
AshleyZhao added a commit to AshleyZhao/modelmesh-serving that referenced this issue Jun 15, 2023
@AshleyZhao
Copy link
Contributor

Thanks Rafael, have a great rest of the week.
Please let me know if you have further suggestions @ckadner, thanks in advance.
For reference, here is my PR, #398.

@rafvasq rafvasq closed this as completed Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants