Get Started updates

[omesser]

https://mlem-ai-simplify-get-st-gwz7i9.herokuapp.com/doc/get-started

I've identified some issues which in my mind make the get started not as appealing and simple to understand as it could be

• The get started workflows today are "actions" - applying/serving/building/deploying. New users might not understand what those mean, in what order should they "put the pieces to gether" and this might lose apeal.
  Some questions I can imagine here for new ysers:

  • "where should I start? I obviously care about all of those, I think"
  • "deploying vs serving? sounds the same"
  • "what does applying a model mean"?
  • "does it make sense to learn about deploying without building? building before applying?"

• "productionization" term is not a clear / common enough in my mind. It's a big catch-all term. it's the umbrella for all current get-started guides.

My Suggestion here - let's have full scenarios drive the GS structure - so less scenarios (2), more stages in each

Suggested Structure:

- Model Prediction
	- loading model and predicting in code
	- batch scoring
- Deploying and serving models
	- running a local server
	- building/packaging models
	- deploying models to cloud

[github-actions]

d434045

Link Check Report

• content/docs/get-started/deploying-and-serving.md
  • /doc/get-started/management = https://mlem-ai-simplify-get-st-gwz7i9.herokuapp.com/doc/get-started/management (404)
  • /doc/get-started/management#saving-your-model = https://mlem-ai-simplify-get-st-gwz7i9.herokuapp.com/doc/get-started/management#saving-your-model (404)

2/24 links failed.

[jorgeorpinel]

Great Qs cc @aguschin . Relates to discussion in #58 (comment) (in fact this PR may close that issue).

[jorgeorpinel]

Suggested Structure

• basic model management ... saving and loading ... model inferencing and batch scoring
• Deploying and serving models ... running a local server ... building/packaging ... deploying to cloud

For the record, what I originally recommended was similar:

combining the multiple current pages into 2 larger/more meaningful sections
i. Capturing models (saving + packaging?)
ii. Productionizing (applying, serving, deploying)

Though I also think that the saving part is pretty good for the index of the section, as is now. (Does that answer "where should I start?" or do we mean"where to go after saving?")

[jorgeorpinel]

the saving part is pretty good for the index of the section, as is now.

Comparing with the new index page, my conviction that the existing one is preferable increases. Specific reasons:

[jorgeorpinel]

I love the intention in this PR however other than the changes I reviewed above, we're mainly regrouping existing content. The grouping is probably good but should be combined with summarizing things because in this proposal one of the pages is pretty short and the second one kind of long (they don't seem to be at the same conceptual level). We also add notes and paragraphs making it even longer which worries me.

Get Started's are tricky 😓

[aguschin]

We also add notes and paragraphs making it even longer which worries me

@jorgeorpinel, does your comment refers to the sections like these? I understand your intention, but I think those make things much clear. Besides, we "sell" MLEM. We can hide them in <details> as an option, but I believe these can be very helpful. WDYT?

[jorgeorpinel]

We also add notes and paragraphs making it even longer

does your comment refers to the sections like these?

Yes. The intention is good but we need the GS to be as brief and direct as possible. If we need to clarify something with an entire new section then it probably wasn't written properly in the first place (or there's an underlying product design issue).

p.s. sorry for late reply. Will check #238 post-merge.