dvc.org icon indicating copy to clipboard operation
dvc.org copied to clipboard

studio/guide: merge How it Works; flatten Views and Exps

Open jorgeorpinel opened this issue 2 years ago • 3 comments

Depends on https://github.com/iterative/dvc.org/pull/3621

  • Merge similar info. from Studio docs homes, How it Works page (gone), and Prepare your repos

    • [x] Merge all info about ~~views~~ projects into one guide
    • [ ] Merge all info about experiments into another guide
  • [ ] Un-burry guides under UG -> ~~Views~~ Projects and Experiments

    Extracted from https://github.com/iterative/dvc.org/pull/3621#pullrequestreview-995958843

jorgeorpinel avatar Jun 05 '22 18:06 jorgeorpinel

@jorgeorpinel Since we've renamed Views to Projects, and since this PR depends on #3621, looks like this isn't straightforward to review. what do you suggest - shall we rebase #3621 and redo changes from this PR?

tapadipti avatar Jul 14 '22 10:07 tapadipti

@tapadipti I'll solve the conflicts but this draft is still incomplete. Not a priority, don't worry about it much now. I know you have more pressing docs needs. We can even close it and reopen/ discuss later. In fact I'd appreciate more any feedback on the plan for this PR as detailed in the description (OP) above.

jorgeorpinel avatar Jul 19 '22 01:07 jorgeorpinel

@jorgeorpinel ok, let's revisit this later.

tapadipti avatar Jul 19 '22 07:07 tapadipti

@tapadipti @jorgeorpinel any updates here?

shcheklein avatar Oct 01 '22 23:10 shcheklein

@shcheklein No, we have not discussed this recently.

@jorgeorpinel it would be good to restructure the docs a bit to "un-bury guides" as you have stated. But in the form in this PR, the pages are going to be quite long. Eg, I looked at the content/docs/studio/user-guide/projects.md page, and it's very long.

I think it'll be good to tackle this in steps - first, let's split the projects and experiments contents. Then, we can improve further.

Also, the following types of changes can be a different PR, coz they aren't about the structure:

image

Let me know what you think about when we can work this out. I'm currently working on the Live Metrics docs, and the feature is expected to go live in 1 week or so. So any restructuring would have to be done either within 1-2 days or would have to wait until the Live Metrics docs are released.

tapadipti avatar Oct 02 '22 10:10 tapadipti

It'll be easier to start over at this point since there are so many conflicts per other changes to Studio docs.

jorgeorpinel avatar Oct 10 '22 14:10 jorgeorpinel