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

DVC home page + updates #3833

Closed
1 of 4 tasks
jorgeorpinel opened this issue Jul 29, 2022 · 13 comments
Closed
1 of 4 tasks

DVC home page + updates #3833

jorgeorpinel opened this issue Jul 29, 2022 · 13 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints website Link checker? (automatic)

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jul 29, 2022

UPDATE: Jump to #3833 (comment).

  • Q: Are there any issues with the download button pending?
  • Update animated dvc command samples (compare to README's Quick start).
  • “Learn more”: do we still want this Header, diagrams and sections? Update it at least -- should we unify this with Features/ Use Cases?
  • Features page: Remove it? (check analytics) And/or merge with Core features from docs
  • Use Cases: Should probably go top-level (not in /doc); Replace Features page? Extract (some) to iterative.ai ?
  • (Advanced) Consider using more media types like videos or gifs.
@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement website Link checker? (automatic) p1-important Active priorities to deal within next sprints labels Jul 29, 2022
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Jul 29, 2022

Cc @dberenbaum @shcheklein @iterative/websites any other needs?

From several of the above I can generalize that we have an unclear mix of features and use cases in different places. Should it be about value-proposition and competitive advantages in the home page (README framework), TOFU/adoption in landing pages ("applications"), and leave feature lists and details for the docs?

From there we should make some decisions and start scheduling content and design work.

@dberenbaum
Copy link
Contributor

I'm not sure where features should live, but otherwise LGTM.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Sep 29, 2022

The OP seems reasonable, but as per a previous meeting, we should attempt to define what the DVC home page should be from scratch (without considering existing content). After that we can see which existing content is still relevant and whether the original plan above still makes sense.

@dberenbaum and @jendefig have been tasked to define and drive this one. Please include me (or others) in the parts where you think we can help (e.g. clarifying or combining Features vs Use Cases). Thanks

@dberenbaum
Copy link
Contributor

Some thoughts on content:

  • Features: for now, we can focus on 3 main components of DVC: data management, pipelines, and experiments.
  • What it is: CLI tool with accompanying Python API and VS Code extension.
  • Primary use case: reproducible ML model development.
  • Other key info: open source, built to work with Git and typical software stack, focus on data-centric ML.

@shcheklein @jendefig Any thoughts?

@shcheklein
Copy link
Member

focus on data-centric ML.

Not sure about this one, but otherwise it seems like a reasonable start to me.

@dberenbaum
Copy link
Contributor

One more thought: how much should it focus on the rest of the Iterative ecosystem (both Studio and other products)?

I'd suggest we mention the Iterative ecosystem and link to other tools without explanation, but explain that Studio is a commercial (but free for individuals) collaboration platform for DVC and the Iterative ecosystem.

@jorgeorpinel
Copy link
Contributor Author

What it is: CLI tool with accompanying Python API and VS Code extension.

I thought we wanted to give equal weight to all the interfaces TBH. Maybe this is an opportunity to show the visual ones (VSC IDE and Studio) first or along with CLI and API? Even if we know CLI is the most complete one still.

how much should it focus on the rest of the Iterative ecosystem

Since DVC is the most popular tool, linking to others prominently could help drive traffic to them at the very least. So for that reason any way we can put them in the home page (not just buried in the current menu) could be desirable.

@jorgeorpinel
Copy link
Contributor Author

Features: data management, pipelines, and experiments

"Features" may not be high-level enough. Should we focus on solutions/ use cases (value) for the home page? At least nearest to the top. Could be as easy as rephrase the "feature" names (and the way we present them) e.g. data mgmt -> manage data effectively; pipelines -> adopt GitOps for your ML workflows; etc. (just quick ideas)

@jendefig
Copy link
Contributor

jendefig commented Oct 10, 2022

Update animated dvc command samples (compare to README's Quick start).

Shouldn't we look at the most used commands/workflows for this?

“Learn more”: do we still want this Header, diagrams and sections?

The images for this section are very hard to understand unless you already know what DVC is and how it all works. It's unclear what the icons are in the first image. Even though I've looked at these images 100 + times, I did not realize until today the dotted lines that are showing the way through it. They are far too light. I think spending the time to turn this into an animated image would be desirable and make things significantly more clear.

should we unify this with Features/ Use Cases?

Yes. I didn't understand why it was not on the landing page to begin with. (Other than it makes it long). And it is high up in the list, but for some reason has had an increasing bounce rate since late June, which must be because we added the link to the VS Code extension then right at the top. I would suggest moving Features to the main landing page.
image

Use Cases: Should probably go top-level (not in /doc); Replace Features page? Extract (some) to iterative.ai ?
(Advanced) Consider using more media types like videos or gifs.

I think it would make sense to have these use cases as clickable blocks (building blocks) in some kind of diagram that harkens back to the Readiness scale that Jervis created. Or clickable sections of the MLOps double infinity loop or Casper's diagram (which I can't find, but I know is somewhere in slack.). This will orient people to where they are in the process conceptually.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Oct 15, 2022

look at the most used commands/workflows

We should use the intended onboarding experience(s) instead, I think (TBD). Is that exp init? On CLI or on the VSCode extension? Maybe also add tabs for secondary onboarding using more traditional (and widely used) commands (add, push, stage add, repro). These are the most important product questions to answer first IMO.

images for this section are very hard to understand unless you already know what DVC is

this into an animated image

Not sure. Maybe just much more simple diagrams you can read instantly.

moving Features to the main landing page

Features are kind of low level IMO. Depending what we mean by that word

have these use cases as clickable blocks...

Good ideas but our current "use cases" are more of independent solutions, not really blocks to combine. Some can be combined but they're not meant for that, they're meant to capture people looking for solutions to certain high-level problems in the industry.

@dberenbaum
Copy link
Contributor

  • Features page: Remove it? (check analytics) And/or merge with Core features from docs

Returning to this point, in addition to the home page redesign, I would like to remove the "Features" page. It has a consistently high bounce rate and I don't see any content there that needs to be preserved.

@jendefig
Copy link
Contributor

@yathomasi We are ready to start exploring the design of the logo carousel for the DVC Home page redo. The folder with logos is here. We are still working on collecting them. I would like to see it be a relatively thin line between sections, one logo high, so that it doesn't take up too much space and people can continue to digest the rest of the material on the site. Also, this way it would look like it's never-ending. Is it right to have this here or should we create a separate PR?

@dberenbaum
Copy link
Contributor

Let's close this one and open new issues as needed for specific improvements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints website Link checker? (automatic)
Projects
None yet
Development

No branches or pull requests

4 participants