ref: replace dvc run examples with dvc stage add + dvc exp run or dvc repro

[iesahin]

In the command reference, there are several examples using dvc run. Replacing these with dvc stage add may lead to clear examples.

• ref: Update dvc run references in dvc add #3023
• ref: Update dvc run references in dvc commit #3031
• ref: update dvc run references in dvc dag #3183
• ref: Update dvc run references in dvc freeze and dvc unfreeze #3070
• ref: Update index page
• ref: Update dvc run references in dvc gc
• ref: Update dvc run references in dvc import-url
• ref: Update dvc run references in dvc init
• ref: Update dvc run references in dvc metrics
• ref: Update dvc run references in dvc params
• ref: Update dvc run references in dvc plots
• ref: Update dvc run references in dvc repro
• ref: Update dvc run references in dvc remove #3103
• ref: Update dvc run references in dvc root #3053
• ref: Update dvc run references in dvc status
• ref: Add a "deprecated" notice to dvc run ?

[jorgeorpinel]

ref: Add a "deprecated" notice to dvc run

I don't think it's deprecated though. I forget what the plan is but I think there's an issue about it on the core repo. Cc @dberenbaum

[iesahin]

I believe, from the earlier discussions, dvc run is deprecated and may be removed in later versions. Can we have an official decision on this? @shcheklein @dberenbaum

[dberenbaum]

Related discussions/issues:

• doc: change run mentions to dvc.yaml or stage add + repro #2076
• replace dvc run dvc#5846
• run: deprecate in favor of stage add dvc#5819

We haven't made progress towards deprecation, but I think we have at least agreed on emphasizing stage add. I have no objection to replacing the examples.

[jorgeorpinel]

Could the DVC team finish the cmd ref updates related to this @dberenbaum ?

@iesahin maybe we should just double check no other docs still use run unnecessrily.

[jorgeorpinel]

Looks like a few tasks may still be pending or need discussing a little. Reopening for now...

I'll update the check boxes in the description as needed. ✔️

[jorgeorpinel]

UPDATE: Looks like it's just about https://dvc.org/doc/command-reference/gc but as long as we haven't actually deprecated run we can leave that link (as well as the one in https://dvc.org/doc/command-reference/status). So never mind 😬

[jorgeorpinel]

Do we have an issue to do the same for guides and use cases though? ⌛

[dberenbaum]

@jorgeorpinel I'm not sure about guides and use cases, but I did take a look at getting started, and it seems like it will require more of an overhaul than just replacing text. I think it would have to be a dedicated project for someone to update it.

[jorgeorpinel]

I did take a look at getting started, and it seems like it will require more of an overhaul than just replacing text

Yeah let's leave that to @iesahin for now then?

BTW I did find an existing issue that's related so I'm updating it to follow up on all this: #2076

[iesahin]

I took over #2076. We can discuss the remaining parts there. This issue was specific to REF.