From ed402c895f839b62c2747b5e3521f6a717d5ffbe Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 27 Jan 2022 23:57:38 -0600 Subject: [PATCH] ref: rewrite Typical Workflow in index page rel. https://github.com/iterative/dvc.org/pull/3223#discussion_r793877815 --- content/docs/command-reference/index.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/content/docs/command-reference/index.md b/content/docs/command-reference/index.md index 9a3274647f..1755bf7f24 100644 --- a/content/docs/command-reference/index.md +++ b/content/docs/command-reference/index.md @@ -10,16 +10,14 @@ does not change directories in your terminal). ## Typical DVC workflow -- In an existing Git repository, initialize a DVC project with - `dvc init`. -- Copy data files or dataset directories for modeling into the repository, and - track them with DVC using the `dvc add` command. -- Process the data with your own source code, using `dvc.yaml` and/or the - `dvc stage add` command to specify further outputs that should - also be tracked by DVC, and executing the code using `dvc repro`. -- Sharing a DVC repository with the codified data - [pipeline](/doc/command-reference/dag) will not include the project's - cache. Use [remote storage](/doc/command-reference/remote) and - `dvc push` to share this cache (data tracked by DVC). -- Use `dvc repro` to automatically reproduce your full pipeline iteratively as - input data or source code change. +- Initialize a DVC project in a Git repo with `dvc init`. +- Copy data files or dataset directories for modeling into the project and use + `dvc add` to tell DVC to cache and track them. +- Create a simple `dvc.yaml` file to codify a data processing + [pipeline](/doc/command-reference/dag). It uses your own source code and + specifies further data outputs for DVC to control. +- Execute or restore any version of your pipeline using `dvc repro`, or + experiment on it with `dvc exp` features. +- Sharing the repository will not include locally cached data. Use + [remote storage](/doc/command-reference/remote) with `dvc push` and `dvc pull` + to share data artifacts.