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

doc: change run mentions to dvc.yaml or stage add + repro #2076

Closed
4 of 7 tasks
jorgeorpinel opened this issue Jan 6, 2021 · 6 comments
Closed
4 of 7 tasks

doc: change run mentions to dvc.yaml or stage add + repro #2076

jorgeorpinel opened this issue Jan 6, 2021 · 6 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: cases Content of /doc/use-cases C: guide Content of /doc/user-guide C: start Content of /doc/start p1-important Active priorities to deal within next sprints

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jan 6, 2021

Based on work in #2075

We should be emphasizing writing/generating dvc.yaml files instead of using dvc run, yet there'sstill around 50 several run links and examples throughout docs:

Links

Examples

Many should be replaced by hand-written dvc.yaml files and at least one with a dvc.yaml file generation script (new example in dvc root per #1637 (comment))


ADDITION from #2578:

  • State this clearly in the docs, and the why (advanced dvc.yaml features?)
    Try to use a descriptive rather than prescriptive explanation...

stage add is still clearly useful, perhaps even preferred for certain cases:

  • Simple stages or beginner users e.g. dvc stage add -n test echo test
  • Programmatic stage generation, esp. to "bootstrap" a pipeline structure (to manage manually later)
@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions A: docs Area: user documentation (gatsby-theme-iterative) 2.0 release labels Jan 6, 2021
@jorgeorpinel jorgeorpinel changed the title dvc.yaml: move several run examples to dvc.yaml examples t/o docs dvc.yaml: change run examples to dvc.yaml examples t/o docs Jan 6, 2021
@jorgeorpinel jorgeorpinel added the p1-important Active priorities to deal within next sprints label Jan 6, 2021
@jorgeorpinel jorgeorpinel changed the title dvc.yaml: change run examples to dvc.yaml examples t/o docs dvc.yaml: change run examples for dvc.yaml or stage add Apr 8, 2021
@jorgeorpinel jorgeorpinel changed the title dvc.yaml: change run examples for dvc.yaml or stage add doc: change run examples for dvc.yaml or stage add Apr 28, 2021
@iesahin iesahin removed the dvc label Oct 14, 2021
@jorgeorpinel jorgeorpinel added C: guide Content of /doc/user-guide C: start Content of /doc/start labels Jan 27, 2022
@jorgeorpinel jorgeorpinel changed the title doc: change run examples for dvc.yaml or stage add doc: change run mentions to dvc.yaml or stage add Jan 27, 2022
@jorgeorpinel jorgeorpinel added C: cases Content of /doc/use-cases ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement and removed type: enhancement Something is not clear, small updates, improvement suggestions labels Jan 28, 2022
@jorgeorpinel
Copy link
Contributor Author

@iesahin would you be interested in moving this epic along since you were working on #3183 ?

@jorgeorpinel jorgeorpinel changed the title doc: change run mentions to dvc.yaml or stage add doc: change run mentions to dvc.yaml or stage add + repro Jan 28, 2022
@iesahin iesahin self-assigned this Jan 31, 2022
@iesahin
Copy link
Contributor

iesahin commented Jan 31, 2022

As we have closed #2997, let me check this, thank you.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Feb 9, 2022

#2997 was mainly about references, this one is for Get Started and Guides. I can take care of the Use Cases... ⌛

@jorgeorpinel
Copy link
Contributor Author

I can take care of the Use Cases... ⌛

Actually there's nothing worth changing there so that section is checked off now. Thanks

@jorgeorpinel jorgeorpinel removed the ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement label Apr 27, 2022
@iesahin iesahin removed their assignment Jun 21, 2022
@daavoo
Copy link
Contributor

daavoo commented Jul 21, 2022

I would add to the list the main page https://dvc.org/

@dberenbaum
Copy link
Contributor

I don't see any remaining instances of dvc run 🎉 . Closing this one.

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 C: guide Content of /doc/user-guide C: start Content of /doc/start p1-important Active priorities to deal within next sprints
Projects
None yet
Development

No branches or pull requests

4 participants