Skip to content

Adding Quick-Start Guide to docs#1315

Merged
adriangonz merged 3 commits into
SeldonIO:masterfrom
ramonpzg:quick-start
Jul 26, 2023
Merged

Adding Quick-Start Guide to docs#1315
adriangonz merged 3 commits into
SeldonIO:masterfrom
ramonpzg:quick-start

Conversation

@ramonpzg

Copy link
Copy Markdown
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 requested review from adriangonz and edshee July 25, 2023 23:33
@ramonpzg ramonpzg self-assigned this Jul 25, 2023
@ramonpzg ramonpzg added the documentation Improvements or additions to documentation label Jul 25, 2023

@edshee edshee left a comment

Copy link
Copy Markdown
Contributor

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!

Comment thread docs/quick-start/index.md Outdated
Comment thread docs/quick-start/index.md
Comment thread docs/quick-start/index.md
Comment thread docs/quick-start/index.md
Comment thread docs/quick-start/index.md Outdated
Comment thread docs/quick-start/index.md
Comment thread docs/quick-start/index.md

@adriangonz adriangonz left a comment

Copy link
Copy Markdown
Contributor

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
Comment thread docs/index.md
@adriangonz
adriangonz merged commit db167f4 into SeldonIO:master Jul 26, 2023
@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