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

Adding Quick-Start Guide to docs #1315

Merged
merged 3 commits into from
Jul 26, 2023
Merged

Conversation

ramonpzg
Copy link
Contributor

This Quick-Start guide provides new users with a straightforward set of instructions on how to get up and running with MLServer. In addition, it provides seasoned users with a fresh perspective on how to explain some of the features of MLServer.

The Quick-Start guide is divided into the following sections.

  • 00 What is MLServer?
  • 01 Dependencies
  • 02 Set Up
  • 03 Building a Service
  • 04 Testing our Service
  • 05 Creating Model Replicas
  • 06 Packaging our Service

There are also a few images being added to the assets directory inside the docs.

There is one more minor change to the main docs conf.py file. Instead of saying "2021, Seldon Technologies" it now says "2023, Seldon Technologies".

@ramonpzg ramonpzg self-assigned this Jul 25, 2023
@ramonpzg ramonpzg added the documentation Improvements or additions to documentation label Jul 25, 2023
Copy link
Contributor

@edshee edshee left a comment

Choose a reason for hiding this comment

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

A few changes on the readme but otherwise a very good piece of content. Great work Ramon. I particularly love the images!

docs/quick-start/index.md Outdated Show resolved Hide resolved
docs/quick-start/index.md Outdated Show resolved Hide resolved
docs/quick-start/index.md Outdated Show resolved Hide resolved
docs/quick-start/index.md Outdated Show resolved Hide resolved
docs/quick-start/index.md Outdated Show resolved Hide resolved
docs/quick-start/index.md Outdated Show resolved Hide resolved
docs/quick-start/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@adriangonz adriangonz left a comment

Choose a reason for hiding this comment

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

Looks great @ramonpzg ! This will be a great addition to the docs. 🚀

@ramonpzg ramonpzg requested a review from edshee July 26, 2023 12:44
docs/index.md Show resolved Hide resolved
@adriangonz adriangonz merged commit db167f4 into SeldonIO:master Jul 26, 2023
26 checks passed
@ramonpzg ramonpzg deleted the quick-start branch July 26, 2023 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants