Skip to content

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

@jorgeorpinel

Description

@jorgeorpinel

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    A: docsArea: user documentation (gatsby-theme-iterative)C: casesContent of /doc/use-casesC: guideContent of /doc/user-guideC: startContent of /doc/startp1-importantActive priorities to deal within next sprints

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions