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

Pathfinder #3128

Closed
daavoo opened this issue Dec 23, 2021 · 6 comments
Closed

Pathfinder #3128

daavoo opened this issue Dec 23, 2021 · 6 comments
Labels
A: website Area: website C: guide Content of /doc/user-guide C: start Content of /doc/start type: discussion Requires active participation to reach a conclusion. website: design Website graphic design website: eng-doc DEPRECATED JS engine for /doc

Comments

@daavoo
Copy link
Contributor

daavoo commented Dec 23, 2021

It would be nice to have, as an entry point to the docs, a page where users would answer a few Qs (what's your role, what type of data you use). We could then use the answers to propose links to docs we consider relevant:

E.g.:
data scientists -> Experiment Management;
ML engineer → Fast ... Data Caching Hub;
Computer Vision -> Large Dataset Optimization;

@daavoo daavoo added type: discussion Requires active participation to reach a conclusion. website: design Website graphic design labels Dec 23, 2021
@iesahin
Copy link
Contributor

iesahin commented Dec 23, 2021

Instead of asking questions, we can have some links, predefined entry points that we put to highlighted boxes in the home page. These may change every three seconds:

DVC for Data Scientists
....

DVC for ML Engineers
...

DVC for MLOps Engineers
...

DVC for AI Researchers
...

@shcheklein
Copy link
Member

Again, reminds me a multi choice thing like https://spacy.io/usage

@daavoo
Copy link
Contributor Author

daavoo commented Dec 23, 2021

Again, reminds me a multi choice thing like https://spacy.io/usage

https://pytorch.org/ also uses similar multi choice

@iesahin
Copy link
Contributor

iesahin commented Dec 25, 2021

Related #144

@iesahin
Copy link
Contributor

iesahin commented Dec 28, 2021

I remembered we've started some work similar to this in April. We have a very brief document in Notion: https://www.notion.so/iterative/wip-Audiences-ccb7abb9a198476aa0c01581479c5eaf

Determining distinct personas and directing them to the relevant parts of the documentation might be good, but I'm not sure asking the user questions is a right way. People usually don't like to answer questions that must be answered as a prerequisite.

We can create pathways for different kinds of users and make these obvious (in the sidebar, in the landing page.) Suppose the sidebar looks like

  • Get Started
    ** DVC for ML Engineers [Access, Versioning, Pipelines, Experiments]
    ** DVC for Data Scientists [Experiments]
    ** DVC for MLOps Engineers [Access, Versioning, Pipelines]
    ** DVC for Software Engineers [Pipelines, Versioning]
    ...
    ** Get Started for Everyone
    ...

instead of the current Data Versioning / Data Access ... list. A student/enthusiast may start from any of them and we'll be saved from creating too static pathways and asking too many questions.

These pathways may correspond to trails in the GS and may use common content when appropriate.

@jorgeorpinel jorgeorpinel added C: guide Content of /doc/user-guide C: start Content of /doc/start labels Dec 28, 2021
@jorgeorpinel jorgeorpinel changed the title Pathfinder Pathfinder Dec 28, 2021
@jorgeorpinel jorgeorpinel added the website: eng-doc DEPRECATED JS engine for /doc label Dec 28, 2021
@shcheklein shcheklein added A: website Area: website and removed website labels Dec 31, 2021
@shcheklein
Copy link
Member

I think we go partially in that direction with trails.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: website Area: website C: guide Content of /doc/user-guide C: start Content of /doc/start type: discussion Requires active participation to reach a conclusion. website: design Website graphic design website: eng-doc DEPRECATED JS engine for /doc
Projects
None yet
Development

No branches or pull requests

5 participants