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

Revamp Quick Start document #149

Closed
bmicklea opened this issue Mar 21, 2024 · 0 comments · Fixed by #150
Closed

Revamp Quick Start document #149

bmicklea opened this issue Mar 21, 2024 · 0 comments · Fixed by #150
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@bmicklea
Copy link
Contributor

bmicklea commented Mar 21, 2024

We should simplify the quick start and make it more step-by-step so they understand the power of Kit

  • Link to the ModelKit overview for folks who want to learn what a ModelKit is
  • Then link to install guide
  • kit version
  • kit login (docker, azure cr, aws ecr, google cr, github in that order)
  • kit unpack the sample ModelKit
  • [view the directory]
  • kit list
  • kit pack -t
  • kit list
  • kit push
  • link to command reference
  • link to Kitfile overview

We can then follow with helping them build their own ModelKit

  • git clone sample repo
  • author a kitfile
  • kit pack
  • kit push
  • kit list
@bmicklea bmicklea added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 21, 2024
@bmicklea bmicklea self-assigned this Mar 21, 2024
@bmicklea bmicklea linked a pull request Mar 21, 2024 that will close this issue
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant