diff --git a/public/static/docs/changelog/0.35.md b/public/static/docs/changelog/0.35.md index f229851be2..d91118078f 100644 --- a/public/static/docs/changelog/0.35.md +++ b/public/static/docs/changelog/0.35.md @@ -19,7 +19,7 @@ improvements) we have done in the last few months: download the whole project and reproduce all the models. - **`dvc diff`** **command introduced**. Summary statistics for the - directory/file under the DVC control. How many files were + directory/file tracked by DVC. How many files were added/deleted/modified/size: ```diff diff --git a/public/static/docs/command-reference/add.md b/public/static/docs/command-reference/add.md index 2d58084210..e3f37bb09f 100644 --- a/public/static/docs/command-reference/add.md +++ b/public/static/docs/command-reference/add.md @@ -1,7 +1,7 @@ # add -Take a data file or a directory under DVC control (by creating a corresponding -[DVC-file](/doc/user-guide/dvc-file-format)). +Track data files or directories with DVC, by creating a corresponding +[DVC-file](/doc/user-guide/dvc-file-format). ## Synopsis @@ -15,13 +15,13 @@ positional arguments: ## Description -The `dvc add` command is analogous to the `git add` command. By default though, -an added file or directory is also committed to the cache. (Use the -`--no-commit` option to avoid this, and `dvc commit` as a separate step when -ready.) +The `dvc add` command is analogous to `git add`, in that it makes DVC aware of +the target data, as a first step to version it. Data added with DVC is also +committed to the cache (use the `--no-commit` option to avoid this, +and `dvc commit` as a separate step when needed). -The `targets` are files or directories to be places under DVC control. These are -turned into outputs (`outs` field) in a resulting +The `targets` are files or directories to be track with DVC. These are turned +into outputs (`outs` field) in a resulting [DVC-file](/doc/user-guide/dvc-file-format). (See steps below for more details.) Note that target data outside the current workspace is supported, that becomes [external outputs](/doc/user-guide/managing-external-data). @@ -115,7 +115,7 @@ reproducible. ## Example: Single file -Take a file under DVC control: +Track a file with DVC: ```dvc $ dvc add data.xml @@ -184,7 +184,7 @@ pics └── dogs [more image files] ``` -Taking a directory under DVC control as simple as with a single file: +Tracking a directory with DVC as simple as with a single file: ```dvc $ dvc add pics diff --git a/public/static/docs/command-reference/checkout.md b/public/static/docs/command-reference/checkout.md index 2947f2998c..f2c9286d9c 100644 --- a/public/static/docs/command-reference/checkout.md +++ b/public/static/docs/command-reference/checkout.md @@ -17,7 +17,7 @@ positional arguments: ## Description [DVC-files](/doc/user-guide/dvc-file-format) act as pointers to specific version -of data files or directories under DVC control. This command synchronizes the +of data files or directories tracked by DVC. This command synchronizes the workspace data with the versions specified in the current DVC-files. `dvc checkout` is useful, for example, when using Git in the @@ -147,7 +147,7 @@ bigrams-experiment <- Uses bigrams to improve the model This project comes with a predefined HTTP [remote storage](/doc/command-reference/remote). We can now just run `dvc pull` that will fetch and checkout the most recent `model.pkl`, `data.xml`, and other -files that are under DVC control. The model file hash +files that are tracked by DVC. The model file hash `3863d0e317dee0a55c4e59d2ec0eef33` will be used in the `train.dvc` [stage file](/doc/command-reference/run): diff --git a/public/static/docs/command-reference/config.md b/public/static/docs/command-reference/config.md index 11a41307b2..9e189c8d66 100644 --- a/public/static/docs/command-reference/config.md +++ b/public/static/docs/command-reference/config.md @@ -22,9 +22,9 @@ takes a config option `name` (a section and a key, separated by a dot) and its This command reads and updates the DVC configuration files. By default (if none of `--local`, `--global`, or `--system` is provided) a project's config (`.dvc/config`) file is read or modified. This file is by default meant to be -under Git control and should not contain sensitive and/or user-specific -information (passwords, SSH keys, etc). Use `--local`, `--global`, or `--system` -options instead to override project's settings, for sensitive, or user-specific +tracked by Git and should not contain sensitive and/or user-specific information +(passwords, SSH keys, etc). Use `--local`, `--global`, or `--system` options +instead to override project's settings, for sensitive, or user-specific settings. If the config option `value` is not provided and `--unset` option is not used, @@ -95,7 +95,7 @@ remote. See `dvc remote` for more information. ### cache A DVC project cache is the hidden storage (by default located in -the `.dvc/cache` directory) for files that are under DVC control, and their +the `.dvc/cache` directory) for files that are tracked by DVC, and their different versions. (See `dvc cache` and [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories#structure-of-cache-directory) for more details.) This section contains the following options: @@ -109,9 +109,9 @@ for more details.) This section contains the following options: > option, properly transforming paths relative to the current working > directory into paths relative to the config file location. -- `cache.protected` - make files under DVC control read-only. Possible values - are `true` or `false` (default). Run `dvc checkout` after changing the value - of this option for the change to go into effect. +- `cache.protected` - make DVC-tracked files read-only. Possible values are + `true` or `false` (default). Run `dvc checkout` after changing the value of + this option for the change to go into effect. Due to the way DVC handles linking between the data files in the cache and their counterparts in the workspace, it's easy to accidentally @@ -272,7 +272,7 @@ Set cache type: if `reflink` is not available, use `copy`: $ dvc config cache.type reflink,copy ``` -Protect data files under DVC control by making them read-only: +Protect DVC-tracked data files by making them read-only: ```dvc $ dvc config cache.protected true diff --git a/public/static/docs/command-reference/diff.md b/public/static/docs/command-reference/diff.md index 40ba5894f8..b4460f8d0f 100644 --- a/public/static/docs/command-reference/diff.md +++ b/public/static/docs/command-reference/diff.md @@ -146,8 +146,8 @@ The output from this command confirms that there's a difference in the Unlike Git, DVC features controlling entire directories without having to add each individual file. See `dvc add` without `--recursive` for example. `dvc run` -can also put whole directories under DVC control (when these are specified as -command dependencies or outputs). +can track entire directories (when these are specified as command dependencies +or outputs). We can use `dvc diff` to check for changes in a directory by specifying the directory as the target (with option `-t`). Note that we skip the `b_ref` diff --git a/public/static/docs/command-reference/fetch.md b/public/static/docs/command-reference/fetch.md index f27ce175ea..f8699b1381 100644 --- a/public/static/docs/command-reference/fetch.md +++ b/public/static/docs/command-reference/fetch.md @@ -1,6 +1,6 @@ # fetch -Get files that are under DVC control from +Get files or directories tracked by DVC from [remote storage](/doc/command-reference/remote) into the cache. ## Synopsis @@ -43,8 +43,8 @@ project's cache ++ | dvc pull | ``` Fetching could be useful when first checking out a DVC project, -since files under DVC control should already exist in remote storage, but won't -be in the project's cache. (Refer to `dvc remote` for more information on DVC +since files tracked by DVC should already exist in remote storage, but won't be +in the project's cache. (Refer to `dvc remote` for more information on DVC remotes.) These necessary data or model files are listed as dependencies or outputs in a DVC-file (target [stage](/doc/command-reference/run)) so they are required to [reproduce](/doc/get-started/reproduce) the corresponding @@ -64,7 +64,7 @@ for more information on how to configure different remote storage providers. `dvc fetch`, `dvc pull`, and `dvc push` are related in that these 3 commands perform data synchronization among local and remote storage. The specific way in which the set of files to push/fetch/pull is determined begins with calculating -file hashes when these are [added](/doc/get-started/add-files) to DVC. File +file hashes when these are [added](/doc/get-started/add-files) with DVC. File hashes are stored in the corresponding DVC-files (typically versioned with Git). Only the hashes specified in DVC-files currently in the workspace are considered by `dvc fetch` (unless the `-a` or `-T` options are used). @@ -161,8 +161,8 @@ bigrams-experiment <- use bigrams to improve the model This project comes with a predefined HTTP [remote storage](/doc/command-reference/remote). We can now just run `dvc fetch` -to download the most recent `model.pkl`, `data.xml`, and other files that are -under DVC control into our local cache. +to download the most recent `model.pkl`, `data.xml`, and other DVC-tracked files +into our local cache. ```dvc $ dvc status --cloud diff --git a/public/static/docs/command-reference/import.md b/public/static/docs/command-reference/import.md index 5d24211551..b97bf79a57 100644 --- a/public/static/docs/command-reference/import.md +++ b/public/static/docs/command-reference/import.md @@ -47,10 +47,10 @@ actual data. > such as S3, SSH, HTTP, etc. After running this command successfully, the imported data is placed in the -current working directory with its original file name e.g. `data.txt`. An -_import stage_ (DVC-file) is then created, extending the full file or directory -name of the imported data e.g. `data.txt.dvc` – similar to having used `dvc run` -to generate the same output. +current working directory (unless `-o` is used) with its original file name e.g. +`data.txt`. An _import stage_ (DVC-file) is also created in the same location, +extending the name of the imported data e.g. `data.txt.dvc` – similar to having +used `dvc run` to generate the output. DVC-files support references to data in an external DVC repository (hosted on a Git server). In such a DVC-file, the `deps` section specifies the `repo`-`url` @@ -69,10 +69,10 @@ data artifact from the source repo. ## Options - `-o`, `--out` - specify a path (directory and/or file name) to the desired - location to place the imported data in. The default value (when this option - isn't used) is the current working directory (`.`) and original file name. If - an existing directory is specified, then the output will be placed inside of - it. + location to place the imported data and import stage (DVC-file) in. The + default value (when this option isn't used) is the current working directory + (`.`) and original file name. If an existing directory is specified, then the + output will be placed inside of it. - `--rev` - commit hash, branch or tag name, etc. (any [Git revision](https://git-scm.com/docs/revisions)) of the repository to diff --git a/public/static/docs/command-reference/init.md b/public/static/docs/command-reference/init.md index ed96550a39..8d3328896f 100644 --- a/public/static/docs/command-reference/init.md +++ b/public/static/docs/command-reference/init.md @@ -22,8 +22,8 @@ learn more. `.dvc/cache` is one of the most important [DVC directories](/doc/user-guide/dvc-files-and-directories). It will hold all the contents of tracked data files. Note that `.dvc/.gitignore` lists this -directory, which means that the cache directory is not under Git control. This -is a local cache and you cannot `git push` it. +directory, which means that the cache directory is not tracked by Git. This is a +local cache and you cannot `git push` it. ## Options diff --git a/public/static/docs/command-reference/install.md b/public/static/docs/command-reference/install.md index 6eb8ab76a4..7d716dfd40 100644 --- a/public/static/docs/command-reference/install.md +++ b/public/static/docs/command-reference/install.md @@ -40,7 +40,7 @@ This hook automates reminding the user to run either `dvc commit` or **Push**: While publishing changes to the Git remote with `git push`, its easy to forget that the `dvc push` command is necessary to upload new or updated data -files and directories under DVC control to +files and directories tracked by DVC to [remote storage](/doc/command-reference/remote). This hook automates `dvc push`. @@ -52,7 +52,7 @@ This hook automates `dvc push`. - A `post-checkout` hook executes `dvc checkout` after `git checkout` to automatically synchronize the data files with the new workspace state. - A `pre-push` hook executes `dvc push` before `git push` to upload files and - directories under DVC control to remote storage. + directories tracked by DVC to remote storage. If a hook already exists, DVC will raise an exception. In such case, user should try to manually edit existing file or remove it and retry install. diff --git a/public/static/docs/command-reference/push.md b/public/static/docs/command-reference/push.md index 0b26154855..794125ff94 100644 --- a/public/static/docs/command-reference/push.md +++ b/public/static/docs/command-reference/push.md @@ -1,6 +1,6 @@ # push -Uploads files and directories under DVC control to the +Uploads files or directories tracked by DVC to [remote storage](/doc/command-reference/remote). ## Synopsis diff --git a/public/static/docs/command-reference/remote/add.md b/public/static/docs/command-reference/remote/add.md index ba4d21a5fb..3cae1dba4d 100644 --- a/public/static/docs/command-reference/remote/add.md +++ b/public/static/docs/command-reference/remote/add.md @@ -187,7 +187,7 @@ $ dvc remote add myremote "azure://" The connection string can be found in the "Access Keys" pane of your Storage Account resource in the Azure portal. - > 💡Make sure the value is quoted to prevent shell from misprocessing the + > 💡 Make sure the value is quoted to prevent shell from misprocessing the > command. - `container name` - this is the top-level container in your Azure Storage diff --git a/public/static/docs/command-reference/remove.md b/public/static/docs/command-reference/remove.md index 9cc52fc138..ae05f7c2aa 100644 --- a/public/static/docs/command-reference/remove.md +++ b/public/static/docs/command-reference/remove.md @@ -23,7 +23,7 @@ Note that it does not remove files from the DVC cache or remote storage (see want to use or share in the future. Refer to [Updating Tracked Files](/doc/user-guide/updating-tracked-files) to see -how it can be used to replace or modify files that are under DVC control. +how it can be used to replace or modify files that are tracked by DVC. ## Options @@ -43,7 +43,7 @@ how it can be used to replace or modify files that are under DVC control. ## Examples -Let's imagine we have a `data.csv` under DVC control: +Let's imagine have a `data.csv` data file, and track it with DVC: ```dvc $ dvc add data.csv diff --git a/public/static/docs/command-reference/run.md b/public/static/docs/command-reference/run.md index 15c6d936fb..98d0824c3d 100644 --- a/public/static/docs/command-reference/run.md +++ b/public/static/docs/command-reference/run.md @@ -91,15 +91,14 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.) - `-o`, `--outs` - specify a file or directory that is the result of running the `command`. Multiple outputs can be specified: `-o model.pkl -o output.log`. DVC builds a dependency graph (pipeline) to connect different stages with each - other based on this list of outputs and dependencies (see `-d`). DVC takes all - output files and directories under its control and puts them into the cache - (this is similar to what's happening when you use `dvc add`). + other based on this list of outputs and dependencies (see `-d`). DVC tracks + all output files and directories and puts them into the cache (this is similar + to what's happening when you use `dvc add`). -- `-O`, `--outs-no-cache` - the same as `-o` except outputs are not put - automatically under DVC control. It means that they are not cached, and it's - up to a user to save and version control them. This is useful if the outputs - are small enough to be put into Git control, or if these files are not of - future interest. +- `-O`, `--outs-no-cache` - the same as `-o` except that outputs are not tracked + by DVC. It means that they are not cached, and it's up to a user to save and + version control them. This is useful if the outputs are small enough to be put + into Git control, or if these files are not of future interest. - `-m`, `--metrics` - specify a metric type of output. This option behaves like `-o` but also adds `metric: true` in the output record of the resulting stage @@ -107,11 +106,11 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.) numeric values or other information that describes a model (or any other regular output). See `dvc metrics` to learn more about using metrics. -- `-M`, `--metrics-no-cache` - the same as `-m` except files are not put - automatically under DVC control. It means that they are not cached, and it's - up to a user to save and version control them. This is typically desirable - with metric files, because they are small enough to be put into Git control. - See also the difference between `-o` and `-O`. +- `-M`, `--metrics-no-cache` - the same as `-m` except that files are not + tracked by DVC. It means that they are not cached, and it's up to a user to + save and version control them. This is typically desirable with metric files, + because they are small enough to be put into Git control. See also the + difference between `-o` and `-O`. - `-f`, `--file` - specify stage file name. By default the DVC-file name generated is `.dvc`, where `` is file name of the first output @@ -131,10 +130,10 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.) `command`. - `--no-exec` - create a stage file, but do not execute the `command` defined in - it, nor take dependencies or outputs under DVC control. In the DVC-file - contents, the file hash values will be empty; They will be populated the next - time this stage is actually executed. This is useful if, for example, you need - to build a pipeline (dependency graph) first, and then run it all at once. + it, nor track dependencies or outputs with DVC. In the DVC-file contents, the + file hash values will be empty; They will be populated the next time this + stage is actually executed. This is useful if, for example, you need to build + a pipeline (dependency graph) first, and then run it all at once. - `-y`, `--yes` (_deprecated_) - See `--overwrite-dvcfile` below. diff --git a/public/static/docs/command-reference/unprotect.md b/public/static/docs/command-reference/unprotect.md index 9de559b02f..122e2ec90d 100644 --- a/public/static/docs/command-reference/unprotect.md +++ b/public/static/docs/command-reference/unprotect.md @@ -53,7 +53,7 @@ Enable cache protected mode is enabled: $ dvc config cache.protected true ``` -Put a data file under DVC control: +Track a data file with DVC: ```dvc $ ls -lh diff --git a/public/static/docs/get-started/add-files.md b/public/static/docs/get-started/add-files.md index 78b404f622..75dc3642d8 100644 --- a/public/static/docs/get-started/add-files.md +++ b/public/static/docs/get-started/add-files.md @@ -18,8 +18,7 @@ $ dvc get https://github.com/iterative/dataset-registry \ > [Data Registries](/doc/use-cases/data-registries) for more info about this > setup.) -To take a file (or a directory) under DVC control just run `dvc add` on it. For -example: +To track a file (or a directory) with DVC just run `dvc add` on it. For example: ```dvc $ dvc add data/data.xml @@ -35,7 +34,7 @@ $ git commit -m "Add raw data to project" ``` Committing DVC-files with Git allows us to track different versions of the -project data as it evolves with the source code under Git control. +project data as it evolves with the source code tracked by Git.
@@ -53,7 +52,7 @@ $ ls -R .dvc/cache ``` `a304afb96060aad90176268345e10355` above is the hash value of the `data.xml` -file we just added to DVC. If you check the `data/data.xml.dvc` DVC-file, you +file we just added with DVC. If you check the `data/data.xml.dvc` DVC-file, you will see that it has this string inside. ### Important note on cache performance @@ -80,9 +79,9 @@ See [Large Dataset Optimization](/doc/user-guide/large-dataset-optimization) and
If your workspace uses Git, without DVC you would have to manually put each data -file or directory into `.gitignore`. DVC commands that take or make files that -will go under its control automatically takes care of this for you! (You just -have to add the changes with Git.) +file or directory into `.gitignore`. DVC commands that track data files +automatically takes care of this for you! (You just have to add the changes with +Git.) Refer to [Versioning Data and Model Files](/doc/use-cases/versioning-data-and-model-files), diff --git a/public/static/docs/get-started/connect-code-and-data.md b/public/static/docs/get-started/connect-code-and-data.md index 181f9ff39c..65d4aabcb8 100644 --- a/public/static/docs/get-started/connect-code-and-data.md +++ b/public/static/docs/get-started/connect-code-and-data.md @@ -150,10 +150,10 @@ learn the specific details about how they behave, and all of their options. -You don't need to run `dvc add` to place output files (`prepared/train.tsv` and -`prepared/test.tsv`) under DVC control. `dvc run` takes care of this. You only -need to run `dvc push` (usually along with `git commit`) to save them to the -remote when you are done. +You don't need to run `dvc add` to track output files (`prepared/train.tsv` and +`prepared/test.tsv`) with DVC. `dvc run` takes care of this. You only need to +run `dvc push` (usually along with `git commit`) to save them to the remote when +you are done. Let's commit the changes to save the stage we built: diff --git a/public/static/docs/get-started/initialize.md b/public/static/docs/get-started/initialize.md index 61b5360b1f..3c20aabeb4 100644 --- a/public/static/docs/get-started/initialize.md +++ b/public/static/docs/get-started/initialize.md @@ -26,5 +26,5 @@ learn more. > [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories) to > learn about the DVC internal file and directory structure. -The last command, `git commit`, puts the `.dvc/config` and `.dvc/.gitignore` -files (DVC internals) under Git control. +The last command, `git commit`, versions the `.dvc/config` and `.dvc/.gitignore` +files (DVC internals) with Git. diff --git a/public/static/docs/get-started/older-versions.md b/public/static/docs/get-started/older-versions.md index 4fa976e442..3956b58faa 100644 --- a/public/static/docs/get-started/older-versions.md +++ b/public/static/docs/get-started/older-versions.md @@ -23,9 +23,9 @@ These two commands will bring the previous model file to its place in the ### Expand to learn about DVC internals -DVC uses special files called [DVC-files](/doc/user-guide/dvc-file-format) to -track data files, directories, end results that are under DVC control. In this -case, `train.dvc` among other things describes the `model.pkl` file this way: +DVC uses special [DVC-files](/doc/user-guide/dvc-file-format) to track data +files, directories, end results. In this case, `train.dvc` among other things +describes the `model.pkl` file this way: ```yaml outs: diff --git a/public/static/docs/tutorials/deep/define-ml-pipeline.md b/public/static/docs/tutorials/deep/define-ml-pipeline.md index 5899270ce6..3c60e580f1 100644 --- a/public/static/docs/tutorials/deep/define-ml-pipeline.md +++ b/public/static/docs/tutorials/deep/define-ml-pipeline.md @@ -28,10 +28,10 @@ browser to download `data.xml`. (Right-click -At this time, `data/Posts.xml.zip` is an untracked regular file. We can place it -under DVC control using `dvc add` (see below). After executing the command you -will see a new file `data/Posts.xml.zip.dvc` and a change in `data/.gitignore`. -Both of these files have to be committed to the repository. +At this time, `data/Posts.xml.zip` is a regular (untracked) file. We can track +it with DVC using `dvc add` (see below). After executing the command you will +see a new file `data/Posts.xml.zip.dvc` and a change in `data/.gitignore`. Both +of these files have to be committed to the repository. ```dvc $ dvc add data/Posts.xml.zip @@ -59,10 +59,10 @@ Refer to `dvc add`, and `dvc run` for more information on storing and versioning data files with DVC. -Note that to modify or replace a data file that is under DVC control you may -need to run `dvc unprotect` or `dvc remove` first (see the -[Update Tracked File](/doc/user-guide/updating-tracked-files) guide). Use -`dvc move` to rename or move a data file that is under DVC control. +Note that to modify or replace a data file tracked by DVC, you may need to run +`dvc unprotect` or `dvc remove` first (see the +[Update Tracked File](/doc/user-guide/updating-tracked-files) guide). To rename +or move it, you can use `dvc move`. ## Data file internals diff --git a/public/static/docs/tutorials/deep/preparation.md b/public/static/docs/tutorials/deep/preparation.md index 6bb6ca71fc..b2c9f6c321 100644 --- a/public/static/docs/tutorials/deep/preparation.md +++ b/public/static/docs/tutorials/deep/preparation.md @@ -97,8 +97,8 @@ $ git commit -am "init DVC" The `.dvc/cache` directory is one of the most important parts of any DVC project. It will contain all the content of data files. (This is explained in more detail in the next chapter.) Note that the cache -directory is contained in `.dvc/.gitignore`, which means that it won't be under -Git control — It's a local-only directory, and you cannot push it to any Git +directory is contained in `.dvc/.gitignore`, which means that it won't be +tracked by Git — It's a local-only directory, and you cannot push it to any Git remote. For more information refer to diff --git a/public/static/docs/tutorials/pipelines.md b/public/static/docs/tutorials/pipelines.md index a6078cce1b..ad8ebeb713 100644 --- a/public/static/docs/tutorials/pipelines.md +++ b/public/static/docs/tutorials/pipelines.md @@ -149,7 +149,7 @@ CLI. The first stage is to extract XML from the archive. Note that we don't need to run `dvc add` on `Posts.xml` below, `dvc run` saves the data automatically -(commits into the cache, takes the file under DVC control): +(commits into the cache, tracks the file with DVC): ```dvc $ dvc run -d data/Posts.xml.zip \ diff --git a/public/static/docs/tutorials/versioning.md b/public/static/docs/tutorials/versioning.md index cec7a622bf..fa0c5b5c50 100644 --- a/public/static/docs/tutorials/versioning.md +++ b/public/static/docs/tutorials/versioning.md @@ -331,10 +331,10 @@ $ dvc run -f Dvcfile \ Similar to `dvc add`, `dvc run` creates a [DVC-file](/doc/user-guide/dvc-file-format) named `Dvcfile` (specified using the -`-f` option). It puts all outputs (`-o`) under DVC control the same way as -`dvc add` does. Unlike `dvc add`, `dvc run` also tracks dependencies (`-d`) and -the command (`python train.py`) that was run to produce the result. We call such -a DVC-file a "stage file". +`-f` option). It tracks all outputs (`-o`) the same way as `dvc add` does. +Unlike `dvc add`, `dvc run` also tracks dependencies (`-d`) and the command +(`python train.py`) that was run to produce the result. We call such a DVC-file +a "stage file". > At this point you could run `git add .` and `git commit` to save the `Dvcfile` > stage file and its changed outputs to the repository. diff --git a/public/static/docs/user-guide/dvcignore.md b/public/static/docs/user-guide/dvcignore.md index 40f6d48550..5afc16576a 100644 --- a/public/static/docs/user-guide/dvcignore.md +++ b/public/static/docs/user-guide/dvcignore.md @@ -61,7 +61,7 @@ $ tree . ``` We created the `data/` directory with two files. Let's ignore one of them, and -add track the directory with DVC. +track the directory with DVC. ```dvc $ echo data/data1 >> .dvcignore diff --git a/public/static/docs/user-guide/large-dataset-optimization.md b/public/static/docs/user-guide/large-dataset-optimization.md index aaff5dce72..2763edb61e 100644 --- a/public/static/docs/user-guide/large-dataset-optimization.md +++ b/public/static/docs/user-guide/large-dataset-optimization.md @@ -3,8 +3,8 @@ In order to track the data files and directories added with `dvc add` or `dvc run`, DVC moves all these files to the cache. A project's cache is the hidden storage (by default located in -`.dvc/cache`) for files that are under DVC control, and their different -versions. (See `dvc cache` and +`.dvc/cache`) for files that are tracked by DVC, and their different versions. +(See `dvc cache` and [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories) for more details.) diff --git a/public/static/docs/user-guide/updating-tracked-files.md b/public/static/docs/user-guide/updating-tracked-files.md index 95e771f5d8..75f346363d 100644 --- a/public/static/docs/user-guide/updating-tracked-files.md +++ b/public/static/docs/user-guide/updating-tracked-files.md @@ -67,7 +67,7 @@ Edit the content of the file: $ echo "new data item" >> train.tsv ``` -Add the new version of the file back to DVC: +Add the new version of the file back with DVC: ```dvc $ dvc add train.tsv