-
Notifications
You must be signed in to change notification settings - Fork 11
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about this for now?
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
I'll use this PR to update docs based on @shcheklein proposal: The new generated repo is here, please see how it looks now: https://github.com/aguschin/example-mlem-get-started UPD: checks are failing since I need to update iterative/example-mlem-get-started, so that's ok. I'll do that before merging this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about the tags details, but it looks reasonable. One quick feedback - it's not a "use case" (based on the terminology that we use in the other projects). It's a How to, or User Guide, or a tutorial.
Which tag exactly do you mean?
Ok, then I think we need to make it like this Since it looks more important to me than a regular User Guide or How To (and How to is hidden inside User Guide in DVC docs). But that requires writing another high-level motivation page like in the DVC case. If you agree on the approach, I'll create a follow-up ticket to address this. |
@aguschin yep, that structure makes sense to me! |
The concept is a use case I suppose (Productizing DVC projects) but the format here looks like a How to (User Guide) or tutorial-like blog post indeed. Consider moving to one of those sections and possibly writing a short use case page for this (which will link to the guide) -- I can help with this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
E: I see you already plan something like what I just suggested 🙂
All changes addressed. I've just updated https://github.com/iterative/example-mlem-get-started Now merging #132 and iterative/example-repos-dev#109 Thanks for your help and feedback @jorgeorpinel and @shcheklein ! |
No description provided.