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

Restructure and Enhance the QuickStart documentation #58

Closed
heyselbi opened this issue Aug 9, 2023 · 4 comments · Fixed by #61
Closed

Restructure and Enhance the QuickStart documentation #58

heyselbi opened this issue Aug 9, 2023 · 4 comments · Fixed by #61
Assignees
Labels
kind/documentation Improvements or additions to documentation rhods-1.32

Comments

@heyselbi
Copy link
Contributor

heyselbi commented Aug 9, 2023

The new documentation should have sections that answer the following questions:

  • Installation Steps
  • How do you add/deploy a model and a sample inference URL with a sample model in the example?
  • Remove a model (undeploy)
  • Canary rollout, A/B testing
  • How to upgrade runtime?
  • How to access metrics?
@heyselbi heyselbi changed the title Restructure the QuickStart documentation Restructure and Enhance the QuickStart documentation Aug 9, 2023
@heyselbi heyselbi self-assigned this Aug 9, 2023
@heyselbi heyselbi added kind/documentation Improvements or additions to documentation rhods-1.32 labels Aug 9, 2023
@heyselbi heyselbi transferred this issue from opendatahub-io/kserve Aug 21, 2023
@heyselbi
Copy link
Contributor Author

Draft PR: #61

@heyselbi heyselbi linked a pull request Aug 24, 2023 that will close this issue
3 tasks
openshift-merge-robot added a commit that referenced this issue Aug 25, 2023
Issue #58: Update and Restructure Quickstart
@heyselbi
Copy link
Contributor Author

@heyselbi heyselbi reopened this Aug 31, 2023
@bdattoma
Copy link
Contributor

bdattoma commented Sep 4, 2023

Some feedbacks from QE:

  1. In the README.md there are links which bring to blank page with "TO DO" text. The 2 links are:

What's the plan? Shall we leave these blank for the 5 Sept release? @heyselbi @MelissaFlinn

  1. the script based installation guide should mention to set the BREW_TAG variable before running the script, if the "brew" operator type is chosen. cc: @Jooho

  2. in the Procedure section of README.md, it mentions Open Data Hub among the requirements, but it is not a requirement cc: @Jooho

@heyselbi
Copy link
Contributor Author

heyselbi commented Sep 5, 2023

Closing the issue as the main restructuring is complete. Adding two follow up issues:

  1. For two remaining sections: Update runtime and Traffic splitting (issue)
  2. Metrics docs need some clarification on how to obtain certain metrics (issue)

@heyselbi heyselbi closed this as completed Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation rhods-1.32
Projects
Status: No status
Status: No status
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants