Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Docs: update DVC Use Case #132

Merged
merged 8 commits into from
Jul 21, 2022
Merged

Docs: update DVC Use Case #132

merged 8 commits into from
Jul 21, 2022

Conversation

aguschin
Copy link
Contributor

No description provided.

@aguschin aguschin requested a review from shcheklein July 11, 2022 08:54
@aguschin aguschin self-assigned this Jul 11, 2022
@aguschin aguschin added the A: docs Area: user documentation (gatsby-theme-iterative) label Jul 11, 2022
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 11, 2022 08:54 Inactive
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 12, 2022 13:05 Inactive
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a 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?

content/docs/use-cases/dvc.md Outdated Show resolved Hide resolved
content/docs/use-cases/dvc.md Outdated Show resolved Hide resolved
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 13, 2022 10:15 Inactive
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 15, 2022 09:56 Inactive
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 15, 2022 09:57 Inactive
@aguschin aguschin changed the title Docs: mention other ways to install DVC Docs: update DVC Use Case Jul 15, 2022
@aguschin
Copy link
Contributor Author

aguschin commented Jul 15, 2022

I'll use this PR to update docs based on @shcheklein proposal:

image

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.

@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 15, 2022 11:39 Inactive
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 15, 2022 11:40 Inactive
@shcheklein shcheklein temporarily deployed to mlem-ai-docs-add-dvc-in-qfhs6z July 15, 2022 11:52 Inactive
Copy link
Member

@shcheklein shcheklein left a 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.

@aguschin
Copy link
Contributor Author

aguschin commented Jul 18, 2022

Not sure about the tags details

Which tag exactly do you mean?

It's a How to, or User Guide, or a tutorial

Ok, then I think we need to make it like this

image

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).

image

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.

@shcheklein
Copy link
Member

@aguschin yep, that structure makes sense to me!

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jul 19, 2022

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

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.

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a 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 🙂

@aguschin
Copy link
Contributor Author

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 !

@aguschin aguschin merged commit 2cd0170 into main Jul 21, 2022
@aguschin aguschin deleted the docs/add-dvc-install-mention branch July 21, 2022 11:13
@jorgeorpinel jorgeorpinel added C: use-cases Content of /doc/use-cases type: enhancement Something is not clear, small updates, improvement suggestions labels Oct 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: use-cases Content of /doc/use-cases type: enhancement Something is not clear, small updates, improvement suggestions
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants