diff --git a/src/Documentation/glossary.js b/src/Documentation/glossary.js
index 4db7289d38..a6d31a05e5 100644
--- a/src/Documentation/glossary.js
+++ b/src/Documentation/glossary.js
@@ -5,54 +5,60 @@ export default {
'relevant DVC concepts and terminologies which are frequently used.',
contents: [
{
- name: 'Workspace directory',
+ name: 'Workspace',
match: ['workspace'],
- desc:
- 'The **workspace** contains all of your DVC **project** files and ' +
- "directories. It's typically also a Git **repository**. See also " +
- '[`dvc init`](/doc/commands-reference/init).'
+ desc: `
+By "workspace" we refer to the directory containing all your project files. For
+example raw datasets, source code, ML models, etc. A workspace becomes a DVC
+project when [\`dvc init\`](/doc/commands-reference/init) is run, and
+[DVC-files](/doc/user-guide/dvc-file-format) are created in it. It\s typically
+also a Git repository.
+ `
},
{
- name: 'DVC cache',
+ name: 'DVC Cache',
match: ['DVC cache', 'cache', 'cache directory'],
- desc:
- 'The DVC cache is a hidden storage (by default located in the ' +
- '`.dvc/cache` directory) for files that are under DVC control, and ' +
- 'their different versions. For more details, please refer to this ' +
- '[document](/doc/user-guide/dvc-files-and-directories' +
- '#structure-of-cache-directory).'
+ desc: `
+The DVC cache is a hidden storage (by default located in the \`.dvc/cache\`
+directory) for files that are under DVC control, and their different versions.
+For more details, please refer to this
+[document](/doc/user-guide/dvc-files-and-directories#structure-of-cache-directory).
+ `
},
{
- name: 'Data artifact',
+ name: 'Data Artifact',
match: ['data artifact', 'data artifacts'],
- desc:
- 'Any **data** file or directory, as well as intermediate or final ' +
- 'result (such as extracted features or a ML model file) that is ' +
- 'under DVC control. Refer to [Data and Model Files Versioning]' +
- '(/doc/use-cases/data-and-model-files-versioning) for more details.'
+ desc: `
+Any data file or directory, as well as intermediate or final result (such as
+extracted features or a ML model file) that is under DVC control. Refer to
+[Data and Model Files Versioning](/doc/use-cases/data-and-model-files-versioning)
+for more details.
+ `
},
{
- name: 'Import stage',
+ name: 'Import Stage',
match: ['import stage', 'import stages'],
- desc:
- 'Stage (DVC-file) created with the `dvc import` or `dvc import-url` ' +
- 'commands. They represent files or directories from external sources.'
+ desc: `
+Stage (DVC-file) created with the \`dvc import\` or \`dvc import-url\`
+commands. They represent files or directories from external sources.
+ `
},
{
name: 'Output',
match: ['output', 'outputs'],
- desc:
- 'A file or a directory that is under DVC control. See `dvc add`, ' +
- '`dvc run`, `dvc import`, `dvc import-url` commands.'
+ desc: `
+A file or a directory that is under DVC control. See \`dvc add\` \`dvc run\`,
+\`dvc import\`, \`dvc import-url\` commands.
+ `
},
{
name: 'External Dependency',
match: ['external dependency', 'external dependencies'],
- desc:
- 'A DVC-file dependency with origin in an external source, for ' +
- 'example HTTP, SSH, Amazon S3, Google Cloud Storage remote ' +
- 'locations, or even other DVC repositories. See ' +
- '[External Dependencies](/doc/user-guide/external-dependencies).'
+ desc: `
+A DVC-file dependency with origin in an external source, for example HTTP, SSH,
+Amazon S3, Google Cloud Storage remote locations, or even other DVC repositories.
+See [External Dependencies](/doc/user-guide/external-dependencies).
+ `
}
]
}
diff --git a/static/docs/commands-reference/add.md b/static/docs/commands-reference/add.md
index 41a7c8d0aa..41ff03d2be 100644
--- a/static/docs/commands-reference/add.md
+++ b/static/docs/commands-reference/add.md
@@ -105,7 +105,7 @@ models). This way you bring data provenance and make your project reproducible.
location, by including a path in the provided value (e.g.
`-f stages/stage.dvc`).
-## Examples: Single file
+## Example: Single file
Take a file under DVC control:
@@ -158,7 +158,7 @@ $ file .dvc/cache/d8/acabbfd4ee51c95da5d7628c7ef74b
.dvc/cache/d8/acabbfd4ee51c95da5d7628c7ef74b: ASCII text
```
-## Examples: Directory
+## Example: Directory
What if you have not one dog picture, but hundreds of pictures of dogs and cats?
Your goal might be to build an algorithm to identify dogs and cats in pictures,
diff --git a/static/docs/commands-reference/cache/dir.md b/static/docs/commands-reference/cache/dir.md
index 95275daee7..846ff2c390 100644
--- a/static/docs/commands-reference/cache/dir.md
+++ b/static/docs/commands-reference/cache/dir.md
@@ -1,7 +1,7 @@
# cache dir
-Set/unset the cache directory location intuitively (compared to using
-`dvc config cache`).
+Set/unset the cache directory location intuitively (compared to
+using `dvc config cache`).
## Synopsis
@@ -40,7 +40,12 @@ file location**. They are required in the latter form for the config file.
- `-h`, `--help` - prints the usage/help message, and exit.
-## Examples: Using relative path
+- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
+ problems arise, otherwise 1.
+
+- `-v`, `--verbose` - displays detailed tracing information.
+
+## Example: Using relative path
```dvc
$ dvc cache dir ../dir
@@ -54,7 +59,7 @@ $ cat .dvc/config
`../dir` has been resolved relative to the `.dvc/` dir, resulting in
`../../dir`.
-## Examples: Using absolute path
+## Example: Using absolute path
```dvc
$ dvc cache dir /path/to/dir
diff --git a/static/docs/commands-reference/cache/index.md b/static/docs/commands-reference/cache/index.md
index d8a35ba12f..0dfaf3a189 100644
--- a/static/docs/commands-reference/cache/index.md
+++ b/static/docs/commands-reference/cache/index.md
@@ -1,6 +1,6 @@
# cache
-Contains a helper command to set the cache directory location:
+Contains a helper command to set the cache directory location:
[dir](/doc/commands-reference/cache/dir).
## Synopsis
@@ -34,15 +34,3 @@ config option, for more information on file links on different platforms.)
problems arise, otherwise 1.
- `-v`, `--verbose` - displays detailed tracing information.
-
-## Example
-
-The main use of this command is to apply the `-v` and `-q` options to
-`dvc cache dir` which doesn't have them:
-
-```dvc
-$ dvc cache --verbose dir mycache
-DEBUG: Writing '/Users/user/myproject/.dvc/config'.
-$ dvc config cache.dir
-../mycache
-```
diff --git a/static/docs/commands-reference/checkout.md b/static/docs/commands-reference/checkout.md
index ed462622b0..7640c80ee4 100644
--- a/static/docs/commands-reference/checkout.md
+++ b/static/docs/commands-reference/checkout.md
@@ -103,36 +103,21 @@ be pulled from a remote cache using `dvc pull`.
## Examples
-To explore `dvc checkout` let's consider a simple workspace with several
-[stages](/doc/commands-reference/run), and a few Git tags. Then with
-`git checkout` and `dvc checkout` we can see what happens as we shift from tag
-to tag.
+Let's employ a simple workspace with some data, code, ML models, pipeline
+stages, as well as a few Git tags, such as our
+[get started example repo](https://github.com/iterative/example-get-started).
+Then we can see what happens with `git checkout` and `dvc checkout` as we switch
+from tag to tag.
### Click and expand to setup the project
-This step is optional, and you can run it only if you want to run this examples
-in your environment. First, you need to download the project:
+Start by cloning our sample repo if you don't already have it:
```dvc
$ git clone https://github.com/iterative/example-get-started
-```
-
-Second, let's install the requirements. But before we do that, we **strongly**
-recommend creating a virtual environment with
-[virtualenv](https://virtualenv.pypa.io/en/stable/) or a similar tool:
-
-```dvc
$ cd example-get-started
-$ virtualenv -p python3 .env
-$ source .env/bin/activate
-```
-
-Now, we can install requirements for the project:
-
-```dvc
-$ pip install -r requirements.txt
```
@@ -157,7 +142,6 @@ solving the problem:
```dvc
$ git tag
-
baseline <- first simple version of the model
bigram <- use bigrams to improve the model
```
diff --git a/static/docs/commands-reference/commit.md b/static/docs/commands-reference/commit.md
index 58e75b8797..e892d12cbb 100644
--- a/static/docs/commands-reference/commit.md
+++ b/static/docs/commands-reference/commit.md
@@ -90,37 +90,33 @@ into play. It handles that last step of adding the file to the DVC cache.
## Examples
-To explore `dvc commit` let's consider a simple pipeline with several stages:
-the example workspace used in the [Get Started](/doc/get-started) section.
+Let's employ a simple workspace with some data, code, ML models, pipeline
+stages, such as the DVC project created in our [Get Started](/doc/get-started)
+section. Then we can see what happens with `git commit` and `dvc commit` in
+different situations.
### Click and expand to setup the project
-This step is optional, and you can run it only if you want to run this examples
-in your environment. First, you need to download the project:
+Start by cloning our sample repo if you don't already have it:
```dvc
$ git clone https://github.com/iterative/example-get-started
+$ cd example-get-started
```
-Second, let's install the requirements. But before we do that, we **strongly**
-recommend creating a virtual environment with
-[virtualenv](https://virtualenv.pypa.io/en/stable/) or a similar tool:
+Now let's install the requirements. But before we do that, we **strongly**
+recommend creating a virtual environment with a tool such as
+[virtualenv](https://virtualenv.pypa.io/en/stable/):
```dvc
-$ cd example-get-started
$ virtualenv -p python3 .env
$ source .env/bin/activate
-```
-
-Now, we can install requirements for the project:
-
-```dvc
$ pip install -r requirements.txt
```
-Then download the precomputed data using:
+Download the precomputed data using:
```dvc
$ dvc pull --all-branches --all-tags
@@ -221,7 +217,7 @@ $ ls .dvc/cache/70
And we've verified that `dvc commit` has saved the changes into the cache, and
that the new instance of `model.pkl` is in the cache.
-## Example: Running without DVC
+## Example: Running commands without DVC
It is also possible to execute the commands that are executed by `dvc repro` by
hand. You won't have DVC helping you, but you have the freedom to run any script
diff --git a/static/docs/commands-reference/config.md b/static/docs/commands-reference/config.md
index b8ec79597d..c1771c834b 100644
--- a/static/docs/commands-reference/config.md
+++ b/static/docs/commands-reference/config.md
@@ -86,8 +86,8 @@ remote. See `dvc remote` for more information.
The DVC cache is a hidden storage (by default located in the `.dvc/cache`
directory) for files that are under DVC control, and their different versions.
(See `dvc cache` and
-[DVC internal files](/doc/user-guide/dvc-files-and-directories) for more
-details.)
+[DVC internal files](/doc/user-guide/dvc-files-and-directories#structure-of-cache-directory)
+for more details.)
- `cache.dir` - set/unset cache directory location. A correct value must be
either an absolute path or a path **relative to the config file location**.
@@ -180,7 +180,7 @@ more about the state file that is used for optimization.
so that when it needs to cleanup the database it could sort them by the
timestamp and remove the oldest ones. Default quota is set to 50(percent).
-## Examples: Core config options
+## Example: Core config options
Set the `dvc` log level to `debug`:
@@ -200,7 +200,7 @@ $ dvc remote add myremote s3://bucket/path
$ dvc config core.remote myremote
```
-## Examples: Default remotes
+## Example: Default remotes
Use remote `myremote` by default:
@@ -227,9 +227,9 @@ which is equivalent to:
$ dvc config core.remote -u
```
-## Examples: Cache config options
+## Example: Cache config options
-Set the cache directory to an absolute path:
+Set the cache directory to an absolute path:
```dvc
$ dvc config cache.dir /mnt/cache
diff --git a/static/docs/commands-reference/destroy.md b/static/docs/commands-reference/destroy.md
index e45dc64b83..570f81b7e3 100644
--- a/static/docs/commands-reference/destroy.md
+++ b/static/docs/commands-reference/destroy.md
@@ -13,9 +13,9 @@ usage: dvc destroy [-h] [-q | -v] [-f]
## Description
It removes DVC-files, and the entire `.dvc/` meta directory from the current
-workspace. Note that the DVC cache will normally be removed as well, unless it's
-set to an external location with `dvc cache dir`. (By default a local cache is
-located in the `.dvc/cache` directory.) If you were using
+workspace. Note that the DVC cache will normally be removed as
+well, unless it's set to an external location with `dvc cache dir`. (By default
+a local cache is located in the `.dvc/cache` directory.) If you were using
[symlinks for linking data](/doc/user-guide/large-dataset-optimization) from the
cache, DVC will replace them with copies, so that your data is intact after the
DVC repository destruction.
@@ -31,7 +31,7 @@ DVC repository destruction.
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
```dvc
$ dvc init
@@ -52,10 +52,10 @@ $ ls -a
.git code.py foo
```
-## Example: External Cache Directory
+## Example: External cache directory
-By default, the cache location is `.dvc/cache`. Let's change the cache location
-to `/mnt/cache` and then execute `dvc destroy` command:
+By default, the cache location is `.dvc/cache`. Let's change the
+cache location to `/mnt/cache` and then execute `dvc destroy` command:
```dvc
$ dvc init
diff --git a/static/docs/commands-reference/diff.md b/static/docs/commands-reference/diff.md
index 493ed89922..82ebb12fe3 100644
--- a/static/docs/commands-reference/diff.md
+++ b/static/docs/commands-reference/diff.md
@@ -51,11 +51,10 @@ by the Git SCM, for example when `dvc init` was used with the `--no-scm` option.
- `-v`, `--verbose` - displays detailed tracing information.
-## Examples: Previous version of the same branch
+## Examples
-For the setup of our examples we can use the steps in our
-[Get Started](/doc/get-started) guide up to the
-[Add Files](/doc/get-started/add-files) section.
+For these examples we can use the steps in our [Get Started](/doc/get-started)
+guide, up to the [Add Files](/doc/get-started/add-files) step.
@@ -64,33 +63,26 @@ For the setup of our examples we can use the steps in our
Start by cloning our sample repo if you don't already have it. Then move into
the repo and checkout the
[version](https://github.com/iterative/example-get-started/releases/tag/3-add-file)
-corresponding to the add-files section mentioned above
+corresponding to the _Add Files_ step:
```dvc
$ git clone https://github.com/iterative/example-get-started
-Cloning into 'example-get-started'...
-
$ cd example-get-started
$ git checkout 3-add-file
-Note: checking out '3-add-file'...
-
-$ dvc pull
-Preparing to download data from 'https://remote.dvc.org/get-started'
-...
```
-Now let's create a virtual environment with
-[virtualenv](https://virtualenv.pypa.io/en/stable/) and install the
-requirements.
+Download the precomputed data using:
```dvc
-$ virtualenv -p python3 .env
-$ source .env/bin/activate
-$ pip install -r requirements.txt
+$ dvc pull
+Preparing to download data from 'https://remote.dvc.org/get-started'
+...
```
+## Example: Previous version of the same branch
+
The minimal `dvc diff` command only includes the A reference (`a_ref`) from
which the difference is to be calculated. The B reference (`b_ref`) defaults to
Git `HEAD` (the currently checked out version). To find the general differences
@@ -107,7 +99,7 @@ diff for 'data/data.xml'
added file with size 37.9 MB
```
-## Examples: Specific targets across Git references
+## Example: Specific targets across Git references
We can base this example in the [Experiment Metrics](/doc/get-started/metrics)
and [Compare Experiments](/doc/get-started/compare-experiments) sections of our
diff --git a/static/docs/commands-reference/fetch.md b/static/docs/commands-reference/fetch.md
index f4dff8707c..373d5ac495 100644
--- a/static/docs/commands-reference/fetch.md
+++ b/static/docs/commands-reference/fetch.md
@@ -114,36 +114,20 @@ specified in DVC-files currently in the workspace are considered by `dvc fetch`
## Examples
-To explore `dvc fetch` let's consider a simple
-[pipeline](/doc/get-started/pipeline) with several stages and a few Git tags.
-Then we can see what happens with `fetch` as we shift from tag to tag with
-`git`.
+Let's employ a simple workspace with some data, code, ML models, pipeline
+stages, as well as a few Git tags, such as our
+[get started example repo](https://github.com/iterative/example-get-started).
+Then we can see what happens with `dvc fetch` as we switch from tag to tag.
### Click and expand to setup the project
-This step is optional, and you can run it only if you want to run this examples
-in your environment. First, you need to download the project:
+Start by cloning our sample repo if you don't already have it:
```dvc
$ git clone https://github.com/iterative/example-get-started
-```
-
-Second, let's install the requirements. But before we do that, we **strongly**
-recommend creating a virtual environment with
-[virtualenv](https://virtualenv.pypa.io/en/stable/) or a similar tool:
-
-```dvc
$ cd example-get-started
-$ virtualenv -p python3 .env
-$ source .env/bin/activate
-```
-
-Now, we can install requirements for the project:
-
-```dvc
-$ pip install -r requirements.txt
```
@@ -173,7 +157,7 @@ baseline <- first simple version of the model
bigram <- use bigrams to improve the model
```
-## Examples: Default behavior
+## Example: Default behavior
This project comes with a predefined HTTP
[remote storage](/doc/commands-reference/remote). We can now just run
@@ -218,7 +202,7 @@ Checking out '{'scheme': 'local', 'path': '.../example-get-started/model.pkl'}'
Checking out '{'scheme': 'local', 'path': '.../example-get-started/data/...
```
-## Examples: Specific stages
+## Example: Specific stages
> Please delete the `.dvc/cache` directory first (with `rm -Rf .dvc/cache`) to
> follow this example if you tried the previous one (**Default behavior**).
@@ -250,7 +234,7 @@ Cache entries for the necessary directories, as well as the actual
`data/prepared/test.tsv` and `data/prepared/train.tsv` files were download,
checksums shown above.
-## Examples: With dependencies
+## Example: With dependencies
After following the previous example (**Specific stages**), only the files
associated with the `prepare.dvc` stage file have been fetched. Several
diff --git a/static/docs/commands-reference/get.md b/static/docs/commands-reference/get.md
index c45e3b3f10..7bdc10cb43 100644
--- a/static/docs/commands-reference/get.md
+++ b/static/docs/commands-reference/get.md
@@ -44,7 +44,7 @@ created in the current working directory, with its original file name.
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
> Note that `dvc get` can be used form anywhere in the file system, as long as
> DVC is [installed](/doc/get-started/install).
diff --git a/static/docs/commands-reference/import-url.md b/static/docs/commands-reference/import-url.md
index e3ba13aba9..e946bcc429 100644
--- a/static/docs/commands-reference/import-url.md
+++ b/static/docs/commands-reference/import-url.md
@@ -23,10 +23,10 @@ In some cases it's convenient to add a data file or directory from a remote
location into the workspace, such that it will be automatically updated (by
`dvc repro`) when the external data source changes. Examples:
-- a remote system may produce occasional data files that are used in other
- projects;
-- a batch process running regularly updates a data file to import; and
-- a shared dataset on a remote storage that is managed and updated outside DVC.
+- A remote system may produce occasional data files that are used in other
+ projects.
+- A batch process running regularly updates a data file to import.
+- A shared dataset on a remote storage that is managed and updated outside DVC.
The `dvc import-url` command helps the user create such an external data
dependency. The `url` argument specifies the external location of the data to be
@@ -117,33 +117,30 @@ downloaded file or directory from the external data source.
## Examples
-To illustrate the examples we will be using the project explained in the
-[Get Started](/doc/get-started) section. With it, it's very easy to setup a
-playground for the examples below.
+To illustrate these examples we will be using the project explained in the
+[Get Started](/doc/get-started) section.
### Click and expand to setup the sample project
Follow these instructions before each example below if you actually want to try
-them on your system. First, download the project and `cd` into it:
+them on your system.
+
+Start by cloning our sample repo if you don't already have it. Then move into
+the repo and checkout the
+[version](https://github.com/iterative/example-get-started/releases/tag/2-remote)
+corresponding to the [Configure](/doc/get-started/configure) step:
```dvc
$ git clone https://github.com/iterative/example-get-started
$ cd example-get-started
-```
-
-The _Get Started_ section demonstrates a simple pipeline. In the
-[Add Files](/doc/get-started/add-files) step we are shown how to download a
-file, then use `dvc add` to integrate it with the workspace. Run:
-
-```dvc
$ git checkout 2-remote
$ mkdir data
```
-After executing these commands you should have a blank workspace, just before
-the _Add Files_ step mentioned before.
+You should now have a blank workspace, just before the
+[Add Files](/doc/get-started/add-files) step.
@@ -261,6 +258,22 @@ $ unzip code.zip
$ rm -f code.zip
```
+
+
+### Click and expand to setup the environment
+
+For this step we'll need to install the project requirements. For that we
+**strongly** recommend creating a virtual environment with a tool such as
+[virtualenv](https://virtualenv.pypa.io/en/stable/):
+
+```dvc
+$ virtualenv -p python3 .env
+$ source .env/bin/activate
+$ pip install -r requirements.txt
+```
+
+
+
```dvc
$ dvc run -f prepare.dvc \
-d src/prepare.py -d data/data.xml \
@@ -332,7 +345,7 @@ WARNING: Stage 'prepare.dvc' changed.
Reproducing 'prepare.dvc'
...
$ dvc status
-Data and pipelines are up to date.[]
+Data and pipelines are up to date.
```
`dvc repro` runs again the given stage `prepare.dvc`, noticing that its
diff --git a/static/docs/commands-reference/import.md b/static/docs/commands-reference/import.md
index 2952039656..16d695c941 100644
--- a/static/docs/commands-reference/import.md
+++ b/static/docs/commands-reference/import.md
@@ -70,7 +70,7 @@ downloaded data artifact from the external DVC repo.
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
An obvious case for this command is to import a dataset from an external DVC
repo, such as our
@@ -109,3 +109,5 @@ outs:
Several of the values above are pulled from the original stage file
`model.pkl.dvc` in the external DVC repo. `url` and `rev_lock` fields are used
to specify the origin and version of the dependency.
+
+
diff --git a/static/docs/commands-reference/lock.md b/static/docs/commands-reference/lock.md
index cbb46275c6..efa457421b 100644
--- a/static/docs/commands-reference/lock.md
+++ b/static/docs/commands-reference/lock.md
@@ -37,58 +37,58 @@ be unlocked. Use `dvc update` on them to update the file, directory, or
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
-- First, let's create a sample DVC-file:
+First, let's create a sample DVC-file:
- ```dvc
- $ echo foo > foo
- $ dvc add foo
- Adding 'foo'...
+```dvc
+$ echo foo > foo
+$ dvc add foo
+Adding 'foo'...
- $ dvc run -d foo -o bar cp foo bar
- Running command:
- cp foo bar
- ...
- ```
+$ dvc run -d foo -o bar cp foo bar
+Running command:
+ cp foo bar
+...
+```
-- Then, let's change the file `foo` that the stage described in `bar.dvc`
- depends on:
+Then, let's change the file `foo` that the stage described in `bar.dvc` depends
+on:
- ```dvc
- $ rm foo
- $ echo foo1 > foo
- $ dvc status
+```dvc
+$ rm foo
+$ echo foo1 > foo
+$ dvc status
- bar.dvc
- deps
- changed: foo
- foo.dvc
- outs
- changed: foo
- ```
+bar.dvc
+ deps
+ changed: foo
+foo.dvc
+ outs
+ changed: foo
+```
-- Now, let's lock the `bar` stage:
+Now, let's lock the `bar` stage:
- ```dvc
- $ dvc lock bar.dvc
- $ dvc status
+```dvc
+$ dvc lock bar.dvc
+$ dvc status
- foo.dvc
- outs
- changed: foo
- ```
+ foo.dvc
+ outs
+ changed: foo
+```
-- Run `dvc unlock` to unlock it back:
+Run `dvc unlock` to unlock it back:
- ```dvc
- $ dvc unlock bar.dvc
- $ dvc status
+```dvc
+$ dvc unlock bar.dvc
+$ dvc status
- bar.dvc
- deps
- changed: foo
- foo.dvc
- outs
- changed: foo
- ```
+ bar.dvc
+ deps
+ changed: foo
+ foo.dvc
+ outs
+ changed: foo
+```
diff --git a/static/docs/commands-reference/pipeline/index.md b/static/docs/commands-reference/pipeline/index.md
index a64d86bb07..3c3eec5b07 100644
--- a/static/docs/commands-reference/pipeline/index.md
+++ b/static/docs/commands-reference/pipeline/index.md
@@ -1,8 +1,8 @@
# pipeline
A set of commands to manage [pipelines](/doc/get-started/pipeline):
-[show](/doc/commands-reference/pipeline/show) - visualize or
-[list](/doc/commands-reference/pipeline/list) - list existing pipelines.
+[show](/doc/commands-reference/pipeline-show) and
+[list](/doc/commands-reference/pipeline-list).
## Synopsis
diff --git a/static/docs/commands-reference/pipeline/list.md b/static/docs/commands-reference/pipeline/list.md
index a18d4b889c..f46838249e 100644
--- a/static/docs/commands-reference/pipeline/list.md
+++ b/static/docs/commands-reference/pipeline/list.md
@@ -26,7 +26,7 @@ their corresponding pipeline(s) when connected. (See `dvc pipeline`.)
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
List available pipelines:
diff --git a/static/docs/commands-reference/pipeline/show.md b/static/docs/commands-reference/pipeline/show.md
index 84fb550d58..71ec7396ba 100644
--- a/static/docs/commands-reference/pipeline/show.md
+++ b/static/docs/commands-reference/pipeline/show.md
@@ -54,77 +54,77 @@ instead of stages.
## Examples
-- Default mode: show stage files that `output.dvc` recursively depends on:
-
- ```dvc
- $ dvc pipeline show output.dvc
- raw.dvc
- data.dvc
- output.dvc
- ```
-
-- The same as previous, but show commands instead of DVC-files:
-
- ```dvc
- $ dvc pipeline show output.dvc --commands
- download.py s3://mybucket/myrawdata raw
- cleanup.py raw data
- process.py data output
- ```
-
-- Visualize DVC pipeline (To navigate, use arrows or `W`, `A`, `S`, `D` keys. To
- exit, press `Q`.):
-
- ```dvc
- $ dvc pipeline show eval.txt.dvc --ascii
- .------------------------.
- | data/Posts.xml.zip.dvc |
- `------------------------'
- *
- *
- *
- .---------------.
- | Posts.xml.dvc |
- `---------------'
- *
- *
- *
- .---------------.
- | Posts.tsv.dvc |
- `---------------'
- *
- *
- *
- .---------------------.
- | Posts-train.tsv.dvc |
- `---------------------'
- *
- *
- *
- .--------------------.
- | matrix-train.p.dvc |
- `--------------------'
- *** ***
- ** ***
- ** **
- .-------------. **
- | model.p.dvc | **
- `-------------' ***
- *** ***
- ** **
- ** **
- .--------------.
- | eval.txt.dvc |
- `--------------'
- ```
-
-- List dependencies recursively if graph have tree structure:
-
- ```dvc
- dvc pipeline show e.file.dvc --tree
- e.file.dvc
- ├── c.file.dvc
- │ └── b.file.dvc
- │ └── a.file.dvc
- └── d.file.dvc
- ```
+Default mode: show stage files that `output.dvc` recursively depends on:
+
+```dvc
+$ dvc pipeline show output.dvc
+raw.dvc
+data.dvc
+output.dvc
+```
+
+The same as previous, but show commands instead of DVC-files:
+
+```dvc
+$ dvc pipeline show output.dvc --commands
+download.py s3://mybucket/myrawdata raw
+cleanup.py raw data
+process.py data output
+```
+
+Visualize DVC pipeline (To navigate, use arrows or `W`, `A`, `S`, `D` keys. To
+exit, press `Q`.):
+
+```dvc
+$ dvc pipeline show eval.txt.dvc --ascii
+ .------------------------.
+ | data/Posts.xml.zip.dvc |
+ `------------------------'
+ *
+ *
+ *
+ .---------------.
+ | Posts.xml.dvc |
+ `---------------'
+ *
+ *
+ *
+ .---------------.
+ | Posts.tsv.dvc |
+ `---------------'
+ *
+ *
+ *
+ .---------------------.
+ | Posts-train.tsv.dvc |
+ `---------------------'
+ *
+ *
+ *
+ .--------------------.
+ | matrix-train.p.dvc |
+ `--------------------'
+ *** ***
+ ** ***
+ ** **
+.-------------. **
+| model.p.dvc | **
+`-------------' ***
+ *** ***
+ ** **
+ ** **
+ .--------------.
+ | eval.txt.dvc |
+ `--------------'
+```
+
+List dependencies recursively if graph have tree structure:
+
+```dvc
+dvc pipeline show e.file.dvc --tree
+e.file.dvc
+├── c.file.dvc
+│ └── b.file.dvc
+│ └── a.file.dvc
+└── d.file.dvc
+```
diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md
index 05ff519c74..eb27f266ca 100644
--- a/static/docs/commands-reference/pull.md
+++ b/static/docs/commands-reference/pull.md
@@ -141,7 +141,7 @@ In this case we left off the `--remote` option, so it will have pulled from the
default remote. The only files considered in this case are what is listed in the
`out` section of the target DVC-file(s).
-## Examples: With dependencies
+## Example: With dependencies
Demonstrating the `--with-deps` flag requires a larger example. First, assume a
[pipeline](/doc/get-started/pipeline) has been setup with these
diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md
index 8d8c7e06d4..1aec92bd61 100644
--- a/static/docs/commands-reference/push.md
+++ b/static/docs/commands-reference/push.md
@@ -145,7 +145,7 @@ $ dvc push data.zip.dvc
[######################] 100% data.zip
```
-## Examples: With dependencies
+## Example: With dependencies
Demonstrating the `--with-deps` flag requires a larger example. First, assume a
[pipeline](/doc/get-started/pipeline) has been setup with these
@@ -209,7 +209,7 @@ Then we ran `dvc push` specifying the last stage, `model.p.dvc`, and its data
was uploaded. Finally, we ran `dvc push` and `dvc status` with no options to
double check that all data had been uploaded.
-## Examples: What happens in the cache
+## Example: What happens in the cache
Let's take a detailed look at what happens to the DVC cache as you run an
experiment in a local workspace and push data to a remote cache. To set the
diff --git a/static/docs/commands-reference/remote/add.md b/static/docs/commands-reference/remote/add.md
index 4c41a5f237..e1c170b8aa 100644
--- a/static/docs/commands-reference/remote/add.md
+++ b/static/docs/commands-reference/remote/add.md
@@ -329,7 +329,7 @@ $ export OSS_ACCESS_KEY_SECRET='AccessKeySecret'
-## Examples: Custom configuration of an S3 remote
+## Example: Custom configuration of an S3 remote
Add a AWS S3 remote as the _default_ (via `-d` option), and modify its region:
diff --git a/static/docs/commands-reference/remote/modify.md b/static/docs/commands-reference/remote/modify.md
index 829a57e865..10d882af15 100644
--- a/static/docs/commands-reference/remote/modify.md
+++ b/static/docs/commands-reference/remote/modify.md
@@ -295,7 +295,7 @@ For more information on configuring Azure Storage connection strings, visit
-## Examples: Customize an S3 remote
+## Example: Customize an S3 remote
Let's first set up a _default_ S3 remote:
diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md
index a865a861d1..ea9da5b839 100644
--- a/static/docs/commands-reference/repro.md
+++ b/static/docs/commands-reference/repro.md
@@ -206,7 +206,7 @@ Saving information to 'Dvcfile'.
You can now check that `Dvcfile` and `count.txt` have been updated with the new
information, new `md5` checksums and a new result respectively.
-## Examples: Downstream
+## Example: Downstream
The `--downstream` option allows us to only reproduce results from commands
after a specific stage in a pipeline. To demonstrate how it works, let's make a
diff --git a/static/docs/commands-reference/root.md b/static/docs/commands-reference/root.md
index c9bb0bcd75..c8af612021 100644
--- a/static/docs/commands-reference/root.md
+++ b/static/docs/commands-reference/root.md
@@ -24,9 +24,7 @@ command can be used to build a path to a dependency file, command, or output.
- `-v`, `--verbose` - displays detailed tracing information.
-## Examples
-
-1. Basic output:
+## Example: Basic output
```dvc
$ dvc root
@@ -39,7 +37,7 @@ $ dvc root
..
```
-2. Referencing files:
+## Example: Referencing files
```dvc
$ dvc root
diff --git a/static/docs/commands-reference/run.md b/static/docs/commands-reference/run.md
index c39913cdab..a9967d5327 100644
--- a/static/docs/commands-reference/run.md
+++ b/static/docs/commands-reference/run.md
@@ -156,69 +156,69 @@ pipeline.
## Examples
-- A trivial example to play with, try different set of options to see how they
- work. You don't need any actual data or scripts to play with this example:
+A trivial example to play with, try different set of options to see how they
+work. You don't need any actual data or scripts to play with this example:
- ```dvc
- $ mkdir example && cd example
- $ git init
- $ dvc init
- $ mkdir data
- $ dvc run -d data -o metric -f metric.dvc "echo '1' >> metric"
+```dvc
+$ mkdir example && cd example
+$ git init
+$ dvc init
+$ mkdir data
+$ dvc run -d data -o metric -f metric.dvc "echo '1' >> metric"
- Running command:
- echo 'a' >> metric
- Adding 'metric' to '.gitignore'.
- Saving 'metric' to cache '.dvc/cache'.
- Saving information to 'metric.dvc'.
+Running command:
+ echo 'a' >> metric
+Adding 'metric' to '.gitignore'.
+Saving 'metric' to cache '.dvc/cache'.
+Saving information to 'metric.dvc'.
- To track the changes with git run:
+To track the changes with git run:
- git add .gitignore metric.dvc
- ```
+ git add .gitignore metric.dvc
+```
> See [DVC-File Format](/doc/user-guide/dvc-file-format) for more details on the
> text format above.
-- Execute a Python script as a DVC pipeline stage. The stage file name is not
- specified, so a `model.p.dvc` DVC-file is created:
+Execute a Python script as a DVC pipeline stage. The stage file name is not
+specified, so a `model.p.dvc` DVC-file is created:
- ```dvc
- # Train ML model on the training dataset. 20180226 is a seed value.
- $ dvc run -d matrix-train.p -d train_model.py \
- -o model.p \
- python train_model.py matrix-train.p 20180226 model.p
- ```
+```dvc
+# Train ML model on the training dataset. 20180226 is a seed value.
+$ dvc run -d matrix-train.p -d train_model.py \
+ -o model.p \
+ python train_model.py matrix-train.p 20180226 model.p
+```
-- Execute an R script as s DVC pipeline stage:
+Execute an R script as s DVC pipeline stage:
- ```dvc
- $ dvc run -d parsingxml.R -d Posts.xml \
- -o Posts.csv \
- Rscript parsingxml.R Posts.xml Posts.csv
- ```
+```dvc
+$ dvc run -d parsingxml.R -d Posts.xml \
+ -o Posts.csv \
+ Rscript parsingxml.R Posts.xml Posts.csv
+```
-- Extract an XML file from an archive to the `data/` folder:
+Extract an XML file from an archive to the `data/` folder:
- ```dvc
- $ mkdir data
- $ dvc run -d Posts.xml.zip \
- -o data/Posts.xml \
- -f extract.dvc \
- unzip Posts.xml.zip -d data/
- ```
+```dvc
+$ mkdir data
+$ dvc run -d Posts.xml.zip \
+ -o data/Posts.xml \
+ -f extract.dvc \
+ unzip Posts.xml.zip -d data/
+```
-- Place the generated stage file (DVC-file) into a subdirectory:
+Place the generated stage file (DVC-file) into a subdirectory:
- ```dvc
- $ dvc run -d test.txt -f stages/test.dvc -o result.out \
- "cat test.txt | wc -l > result.out"
+```dvc
+$ dvc run -d test.txt -f stages/test.dvc -o result.out \
+ "cat test.txt | wc -l > result.out"
- $ tree .
+$ tree .
- .
- ├── result.out
- ├── stages
- │ └── test.dvc
- └── test.txt
- ```
+.
+├── result.out
+├── stages
+│ └── test.dvc
+└── test.txt
+```
diff --git a/static/docs/commands-reference/unlock.md b/static/docs/commands-reference/unlock.md
index c8efb4a96c..22405447eb 100644
--- a/static/docs/commands-reference/unlock.md
+++ b/static/docs/commands-reference/unlock.md
@@ -33,58 +33,58 @@ be unlocked. Use `dvc update` on them to update the file, directory, or
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
-- First, let's create a sample DVC-file:
+First, let's create a sample DVC-file:
- ```dvc
- $ echo foo > foo
- $ dvc add foo
- Adding 'foo'...
+```dvc
+$ echo foo > foo
+$ dvc add foo
+Adding 'foo'...
- $ dvc run -d foo -o bar cp foo bar
- Running command:
- cp foo bar
- ...
- ```
+$ dvc run -d foo -o bar cp foo bar
+Running command:
+ cp foo bar
+...
+```
-- Then, let's change the file `foo` that the stage described in `bar.dvc`
- depends on:
+Then, let's change the file `foo` that the stage described in `bar.dvc` depends
+on:
- ```dvc
- $ rm foo
- $ echo foo1 > foo
- $ dvc status
+```dvc
+$ rm foo
+$ echo foo1 > foo
+$ dvc status
- bar.dvc
- deps
- changed: foo
- foo.dvc
- outs
- changed: foo
- ```
+bar.dvc
+ deps
+ changed: foo
+foo.dvc
+ outs
+ changed: foo
+```
-- Now, let's lock the `bar` stage:
+Now, let's lock the `bar` stage:
- ```dvc
- $ dvc lock bar.dvc
- $ dvc status
+```dvc
+$ dvc lock bar.dvc
+$ dvc status
- foo.dvc
- outs
- changed: foo
- ```
+ foo.dvc
+ outs
+ changed: foo
+```
-- Run `dvc unlock` to unlock it back:
+Run `dvc unlock` to unlock it back:
- ```dvc
- $ dvc unlock bar.dvc
- $ dvc status
+```dvc
+$ dvc unlock bar.dvc
+$ dvc status
- bar.dvc
- deps
- changed: foo
- foo.dvc
- outs
- changed: foo
- ```
+ bar.dvc
+ deps
+ changed: foo
+ foo.dvc
+ outs
+ changed: foo
+```
diff --git a/static/docs/commands-reference/unprotect.md b/static/docs/commands-reference/unprotect.md
index 5edaf03fa7..9e2f2dd9dc 100644
--- a/static/docs/commands-reference/unprotect.md
+++ b/static/docs/commands-reference/unprotect.md
@@ -43,7 +43,7 @@ when cache protected mode is enabled:
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
Enable cache protected mode is enabled:
diff --git a/static/docs/commands-reference/update.md b/static/docs/commands-reference/update.md
index 9e20e0b386..9e37f37989 100644
--- a/static/docs/commands-reference/update.md
+++ b/static/docs/commands-reference/update.md
@@ -34,7 +34,7 @@ To indicate which import stages to update, specify the corresponding DVC-file
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
Let's first import a data artifact from our
[get started example repo](https://github.com/iterative/example-get-started):
diff --git a/static/docs/commands-reference/version.md b/static/docs/commands-reference/version.md
index 0120520a96..bd54d5802b 100644
--- a/static/docs/commands-reference/version.md
+++ b/static/docs/commands-reference/version.md
@@ -96,7 +96,7 @@ The detail of `Binary` depends on the way DVC was downloading and
- `-v`, `--verbose` - displays detailed tracing information.
-## Example
+## Examples
Getting the DVC version and environment information:
diff --git a/static/docs/get-started/add-files.md b/static/docs/get-started/add-files.md
index 7fc55111d1..9f71e2ce83 100644
--- a/static/docs/get-started/add-files.md
+++ b/static/docs/get-started/add-files.md
@@ -4,6 +4,11 @@ DVC allows storing and versioning data files, ML models, directories,
intermediate results with Git, without checking the file contents into Git.
Let's get a sample dataset to play with:
+```dvc
+$ mkdir data
+$ wget https://dvc.org/s3/get-started/data.xml -O data/data.xml
+```
+
### Expand if you're on Windows or having problems downloading from command line
@@ -16,37 +21,32 @@ into `data` subdirectory. To download, right-click
-```dvc
-$ mkdir data
-$ wget https://dvc.org/s3/get-started/data.xml -O data/data.xml
-```
-
-To take a file (or a directory) under DVC control just run `dvc add`, it accepts
-any file or directory:
+To take a file (or a directory) under DVC control just run `dvc add` on it. For
+example:
```dvc
$ dvc add data/data.xml
```
-DVC stores information about your data file in a special DVC-file, that has a
-human-readable [format](/doc/user-guide/dvc-file-format) and can be committed to
-Git to track versions of your file:
+DVC stores information about the added data in a special **DVC-file** that has a
+human-readable [format](/doc/user-guide/dvc-file-format). It can be committed to
+Git:
```dvc
$ git add data/.gitignore data/data.xml.dvc
$ git commit -m "add raw data to DVC"
```
+Committing these special files to Git allows us to tack different versions of
+the data as it evolves with the source code under Git control.
+
### Expand to learn about DVC internals
You can see that actual data file has been moved to the `.dvc/cache` directory,
while the entries in the workspace may be links to the actual files in the DVC
-cache. (See
-[File link types](/docs/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)
-to learn about the supported file linking options, their tradeoffs, and how to
-enable them).
+cache.
```dvc
$ ls -R .dvc/cache
@@ -54,9 +54,9 @@ $ ls -R .dvc/cache
04afb96060aad90176268345e10355
```
-where `a304afb96060aad90176268345e10355` is an MD5 hash of the `data.xml` file.
-And if you check the `data/data.xml.dvc` DVC-file you will see that it has this
-hash inside.
+`a304afb96060aad90176268345e10355` from above is an MD5 hash of the `data.xml`
+file we just added to DVC. And if you check the `data/data.xml.dvc` DVC-file you
+will see that it has this hash inside.
@@ -85,6 +85,11 @@ and `dvc config cache` for more information.
+If your workspace uses Git, without DVC you would have to manually
+put each data file or directory in 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 to Git.)
+
Refer to
[Data and Model Files Versioning](/doc/use-cases/data-and-model-files-versioning),
`dvc add`, and `dvc run` for more information on storing and versioning data
diff --git a/static/docs/get-started/initialize.md b/static/docs/get-started/initialize.md
index ed339770db..a937cefb59 100644
--- a/static/docs/get-started/initialize.md
+++ b/static/docs/get-started/initialize.md
@@ -1,11 +1,11 @@
# Initialize
-In order to start using DVC, you need first to initialize it in your project's
-directory. DVC doesn't require Git and can work without any source control
-management system, but for the best experience we recommend using DVC on top of
-Git repositories.
+In order to start using DVC, you need first to initialize it in your
+workspace. DVC doesn't require Git and can work without any source
+control management system, but for the best experience we recommend using DVC on
+top of Git repositories.
-If you don't have a directory for your project already, create it now with these
+If you don't have a directory for this project already, create it now with these
commands:
```dvc
diff --git a/static/docs/tutorial/define-ml-pipeline.md b/static/docs/tutorial/define-ml-pipeline.md
index 1b689ebe09..346c5add5f 100644
--- a/static/docs/tutorial/define-ml-pipeline.md
+++ b/static/docs/tutorial/define-ml-pipeline.md
@@ -63,8 +63,8 @@ need to run `dvc unprotect` or `dvc remove` first (see the
If you take a look at the [DVC-file](/doc/user-guide/dvc-file-format) created by
`dvc add`, you will see that only outputs are defined in `outs`. In this file,
only one output is defined. The output contains the data file path in the
-repository and md5 cache. This md5 cache determines a location of the actual
-content file in DVC cache directory `.dvc/cache`.
+repository and md5 checksum. This checksum determines a location of the actual
+content file in the cache directory, `.dvc/cache`.
```dvc
$ cat data/Posts.xml.zip.dvc
@@ -186,8 +186,8 @@ and does some additional work if the command was successful:
1. DVC transforms all the outputs `-o` files into data files. It is like
applying `dvc add` for each of the outputs. As a result, all the actual data
- files content goes to the cache directory `.dvc/cache` and each of the file
- names will be added to `.gitignore`.
+ files content goes to the cache directory `.dvc/cache` and each
+ of the file names will be added to `.gitignore`.
2. For reproducibility purposes, `dvc run` creates the `Posts.xml.dvc` stage
file in the workspace with information about this pipeline stage. (See
diff --git a/static/docs/tutorial/preparation.md b/static/docs/tutorial/preparation.md
index 6462365f9a..75cc7d7f91 100644
--- a/static/docs/tutorial/preparation.md
+++ b/static/docs/tutorial/preparation.md
@@ -68,10 +68,10 @@ DVC works on top of Git repositories. You run DVC initialization in a repository
directory to create DVC meta files and directories.
After DVC initialization, a new directory `.dvc/` will be created with `config`
-and `.gitignore` files and `cache` directory. These files and directories are
-hidden from the user generally and are not meant to be manipulated directly.
-However, we describe some DVC internals below for a better understanding of how
-it works.
+and `.gitignore` files and cache directory. These files and
+directories are hidden from the user generally and are not meant to be
+manipulated directly. However, we describe some DVC internals below for a better
+understanding of how it works.
```dvc
$ dvc init
diff --git a/static/docs/tutorial/reproducibility.md b/static/docs/tutorial/reproducibility.md
index 51eecdba60..ca8fd29cdc 100644
--- a/static/docs/tutorial/reproducibility.md
+++ b/static/docs/tutorial/reproducibility.md
@@ -238,8 +238,11 @@ checksums from the bigram branch: that is, by removing all checksums of the
other branch.
[Here](https://help.github.com/en/articles/resolving-a-merge-conflict-using-the-command-line)
you can find a tutorial which clarifies how to do that. It is also important to
-remove all automatically generated conflict markers (<<<<<<<, =======, >>>>>>>)
-from `model.p.dvc` and `Dvcfile`.
+remove all automatically generated
+[conflict markers](https://git-scm.com/book/en/v2/Git-Tools-Advanced-Merging#_checking_out_conflicts)
+(<<<<<<<
,
+=======
,
+>>>>>>>
) from `model.p.dvc` and `Dvcfile`.
Another way to solve git merge conflicts is to simply replace all checksums with
empty strings ''. The only disadvantage of this trick is that DVC will need to
diff --git a/static/docs/use-cases/multiple-data-scientists-on-a-single-machine.md b/static/docs/use-cases/multiple-data-scientists-on-a-single-machine.md
index 6622526caf..11ac33f8a2 100644
--- a/static/docs/use-cases/multiple-data-scientists-on-a-single-machine.md
+++ b/static/docs/use-cases/multiple-data-scientists-on-a-single-machine.md
@@ -13,12 +13,12 @@ as`git checkout` for your code.
### Preparation
-In order to make it work on a shared server, you need to setup a shared cache
-location for your projects, so that every team member is using the same cache
-storage:
+In order to make it work on a shared server, you need to setup a shared
+cache location for your projects, so that every team member is
+using the same cache storage:
```dvc
-$ mkdir -p /dvc-cache
+$ mkdir -p /path/to/dvc-cache
```
You will have to make sure that the directory has proper permissions setup, so
@@ -33,20 +33,20 @@ permissions.
This step is optional. You can skip it if you are setting up a new DVC
repository and don't have your local cache stored in `.dvc/cache`. If you did
work on your project with DVC previously and you wish to transfer your cache to
-the external cache directory, you will need to simply move it from an old cache
-location to the new one:
+the shared cache directory (external to your workspace), you will
+need to simply move it from an old cache location to the new one:
```dvc
-$ mv .dvc/cache/* /dvc-cache
+$ mv .dvc/cache/* /path/to/dvc-cache
```
-### Configure External Cache
+### Configure External Cache (Optional)
-Tell DVC to use the directory we've set up as an external cache location by
-running:
+This step is optional. Tell DVC to use the directory we've set up above as an
+shared cache location by running:
```dvc
-$ dvc config cache.dir /dvc-cache
+$ dvc config cache.dir /path/to/dvc-cache
```
Commit changes to `.dvc/config` and push them to your git remote:
@@ -56,7 +56,7 @@ $ git add .dvc/config
$ git commit -m "dvc: setup external cache dir"
```
-### Example
+### Examples
You and your colleagues can work in your own workspaces as usual and DVC will
handle all your data in the most effective way possible. Let's say you are
diff --git a/static/docs/user-guide/dvc-files-and-directories.md b/static/docs/user-guide/dvc-files-and-directories.md
index dc43e98b0e..2c8aad4106 100644
--- a/static/docs/user-guide/dvc-files-and-directories.md
+++ b/static/docs/user-guide/dvc-files-and-directories.md
@@ -26,8 +26,8 @@ Once initialized in a project, DVC populates its installation directory
- `.dvc/state` - this file is used for optimization. It is a SQLite db, that
contains checksums for files in a project with respective timestamps and
inodes to avoid unnecessary checksum computations. It also contains a list of
- links (from cache to workspace) created by dvc and is used to cleanup your
- workspace when calling `dvc checkout`.
+ links (from cache to workspace) created by DVC and
+ is used to cleanup your workspace when calling `dvc checkout`.
- `.dvc/state-journal` - temporary file for SQLite operations
diff --git a/static/docs/user-guide/dvcignore.md b/static/docs/user-guide/dvcignore.md
index 5aba5d19f3..5ae2e7c6d4 100644
--- a/static/docs/user-guide/dvcignore.md
+++ b/static/docs/user-guide/dvcignore.md
@@ -43,7 +43,7 @@ handled from `.dvcignore` file from upper levels of the project tree.
The same as for [`.gitignore`](https://git-scm.com/docs/gitignore).
-## Examples: Modification of ignored data
+## Example: Modification of ignored data
Let's see what happens when we modify ignored file.
@@ -106,7 +106,7 @@ data.dvc:
modified: data
```
-## Examples: Moving ignored data
+## Example: Moving ignored data
```dvc
$ mkdir data
@@ -143,7 +143,7 @@ data.dvc:
modified: data
```
-## Examples: Ignore dvc controlled file
+## Example: Ignore dvc controlled file
Let's analyze an example project:
diff --git a/static/docs/user-guide/external-dependencies.md b/static/docs/user-guide/external-dependencies.md
index 7d873265c9..009bed7126 100644
--- a/static/docs/user-guide/external-dependencies.md
+++ b/static/docs/user-guide/external-dependencies.md
@@ -86,7 +86,7 @@ $ dvc run -d https://example.com/data.txt \
wget https://example.com/data.txt -O data.txt
```
-## Examples: Defined with DVC remote aliases
+## Example: Defined with DVC remote aliases
If instead of a URL you'd like to use an alias that can be managed
independently, or if the external dependency location requires access
@@ -127,7 +127,7 @@ The command above creates an import stage specified in DVC-file
### Expand to see resulting DVC-file
```yaml
-...
+# ...
deps:
- etag: '"f432e270cd634c51296ecd2bc2f5e752-5"'
path: https://dvc.org/s3/get-started/data.xml
@@ -167,7 +167,7 @@ dependency is specified.
### Expand to see resulting DVC-file
```yaml
-...
+# ...
deps:
- path: model.pkl
repo:
diff --git a/static/docs/user-guide/large-dataset-optimization.md b/static/docs/user-guide/large-dataset-optimization.md
index d4ea0fe495..e0de1368f4 100644
--- a/static/docs/user-guide/large-dataset-optimization.md
+++ b/static/docs/user-guide/large-dataset-optimization.md
@@ -1,9 +1,9 @@
# Large Dataset Optimization
In order to track the data files and directories added with `dvc add` or
-`dvc run`, DVC moves all these files to a special cache directory. The DVC cache
-is a hidden storage (by default located in `.dvc/cache`) for files that are
-under DVC control, and their different versions. (See `dvc cache` and
+`dvc run`, DVC moves all these files to a special cache directory.
+The DVC cache is a hidden storage (by default located in `.dvc/cache`) for files
+that are under DVC control, and their different versions. (See `dvc cache` and
[DVC internal files](/doc/user-guide/dvc-files-and-directories) for more
details.)
@@ -102,10 +102,10 @@ efficiency:
## Configuring DVC cache file link type
-By default DVC tries to use reflinks if available on your system, however this
-is not the most common case at this time, so it falls back to the copying
-strategy. If you wish to enable hard or soft links, you can configure DVC like
-this:
+By default DVC tries to use reflinks for the cache if available on
+your system, however this is not the most common case at this time, so it falls
+back to the copying strategy. If you wish to enable hard or soft links, you can
+configure DVC like this:
```dvc
$ dvc config cache.type hardlink,symlink