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.

Sign up for GitHub

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

Jump to bottom

docs: Add ModelMesh documentation #110

Merged
merged 10 commits into from
Oct 18, 2023
Merged

docs: Add ModelMesh documentation #110

merged 10 commits into from
Oct 18, 2023

Conversation

rafvasq
Copy link
Member

@rafvasq rafvasq commented Oct 5, 2023 •
edited
Loading

Motivation

Related to #81 and kserve/modelmesh-serving#311, this PR adds more documentation on ModelMesh.

Modifications

  • Create a /docs directory
  • Add various existing docs, including:
    • VModels
    • Configuration/Tuning
    • Scaling
    • Metrics
  • Moves Payload doc into /docs directory
  • Moves getting started/building/deploying information to /docs/README.md

Result

  • Shares more information about ModelMesh's inner-workings and configuration possibilities.
  • An organized /docs directory for learning users and developers.

rafvasq added 2 commits October 5, 2023 15:25
@rafvasq
Adds and restructures docs
5d463dc 
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq
Change flow of MM overviews
1fdbb02 
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq requested review from ckadner and njhill October 5, 2023 19:40
@rafvasq rafvasq changed the title Add docs docs: Add general documentation Oct 5, 2023
@rafvasq rafvasq added the documentation Improvements or additions to documentation label Oct 5, 2023
@rafvasq rafvasq marked this pull request as ready for review October 11, 2023 17:53
@rafvasq rafvasq marked this pull request as draft October 11, 2023 17:53
@rafvasq rafvasq marked this pull request as ready for review October 11, 2023 20:30
@rafvasq
Adds metrics documentation
412346d 
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq
Make overview doc the docs readme
10c412a 
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq changed the title docs: Add general documentation docs: Add ModelMesh documentation Oct 13, 2023
ckadner
ckadner requested changes Oct 17, 2023
View reviewed changes
Copy link
Member

@ckadner ckadner left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rafvasq -- I think this looks good besides one small change request :-)

docs/README.md Outdated Show resolved Hide resolved
@rafvasq rafvasq requested a review from ckadner October 17, 2023 18:31
ckadner
ckadner approved these changes Oct 18, 2023
View reviewed changes
Copy link
Member

@ckadner ckadner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Rafael

/lgtm

@kserve-oss-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ckadner, rafvasq

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ckadner ckadner merged commit 107cffc into kserve:main Oct 18, 2023
3 checks passed
@rafvasq rafvasq deleted the add-docs branch October 19, 2023 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ckadner ckadner ckadner approved these changes

@njhill njhill Awaiting requested review from njhill

Assignees

@ckadner ckadner

Labels
approved documentation Improvements or additions to documentation lgtm
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rafvasq @kserve-oss-bot @ckadner