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

use-cases: revise so they're more high level "landing pages" #820

Closed
3 of 8 tasks
jorgeorpinel opened this issue Nov 26, 2019 · 4 comments · Fixed by #2587
Closed
3 of 8 tasks

use-cases: revise so they're more high level "landing pages" #820

jorgeorpinel opened this issue Nov 26, 2019 · 4 comments · Fixed by #2587
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: cases Content of /doc/use-cases ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Nov 26, 2019

Use cases should have a different focus, so they are more high level and serve as landing pages – single web page that appears in response to clicking on a search engine optimized search result – leaving most details to the user guide. Some relevant quotes from #784 (comment):

This section should answer the question of an infrastructure, DevOps, MLOps folks on how DVC can help them. How can it be used, in what high level scenarios. (And it's even okay if they overlap in this case.)

To reiterate on the Use Cases vs User Guide:
Users Guide is like a car owner's manual - a lot of details, how tos, etc.
Use Cases would be like explaining how that car can be used (potentially referring a lot to the owner's manual to cover the technical details) - driving from home to work, renting, taxi, etc

Note: perhaps we could split this issue into 3. Not 4 because Data Registry is already written in this direction in #818.

Ideas:


Extracted to #2490:

@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions use-cases labels Nov 26, 2019
@jorgeorpinel

This comment has been minimized.

@jorgeorpinel jorgeorpinel changed the title use-cases: revise so they're all high level use-cases: revise so they're more high level "landing pages" Nov 26, 2019
@shcheklein shcheklein added the p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. label Nov 26, 2019
@shcheklein

This comment has been minimized.

@jorgeorpinel jorgeorpinel added the ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement label May 7, 2020
@jorgeorpinel jorgeorpinel added p1-important Active priorities to deal within next sprints and removed p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Aug 26, 2020
@jorgeorpinel jorgeorpinel self-assigned this May 13, 2021
@jorgeorpinel

This comment has been minimized.

@shcheklein

This comment has been minimized.

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) C: cases Content of /doc/use-cases ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants