Merge pull request #509 from jorgeorpinel/master

imports: examples for new `import`, `update` cmd refs; et al [WIP]
iterative · Aug 5, 2019 · 368ba1b · 368ba1b
2 parents f7e5b1a + ff095ae
commit 368ba1b
Show file tree

Hide file tree

Showing 31 changed files with 586 additions and 543 deletions.
diff --git a/src/Documentation/glossary.js b/src/Documentation/glossary.js
@@ -42,8 +42,17 @@ export default {
       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.'
+        '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).'
     }
   ]
 }
diff --git a/static/docs/commands-reference/add.md b/static/docs/commands-reference/add.md
@@ -162,7 +162,7 @@ $ file .dvc/cache/d8/acabbfd4ee51c95da5d7628c7ef74b
 
 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,
-and this is your training data set:
+and this is your training dataset:
 
 ```dvc
 $ tree pics
@@ -191,10 +191,7 @@ Linking directory 'pics'.
 [##############################] 100% pics
 
 Saving information to 'pics.dvc'.
-
-To track the changes with git run:
-
-  	git add pics.dvc
+...
 ```
 
 There are no DVC-files generated within this directory structure, but the images

diff --git a/static/docs/commands-reference/commit.md b/static/docs/commands-reference/commit.md
@@ -91,7 +91,7 @@ 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 [Getting Started](/doc/get-started) tutorial.
+the example workspace used in the [Get Started](/doc/get-started) section.
 
 <details>
 

diff --git a/static/docs/commands-reference/gc.md b/static/docs/commands-reference/gc.md
@@ -40,7 +40,7 @@ usually helps to save some space.
   project is a path) to keep data that is currently referenced from them.
 
 - `-c`, `--cloud` - also remove files in the remote storage. _This operation is
-  dangerous._ It removes data sets, models, other files that are not linked in
+  dangerous._ It removes datasets, models, other files that are not linked in
   the current branch/commit (unless `-a` or `-T` is specified).
 
 - `-r`, `--remote` - name of the remote storage to collect unused objects from

diff --git a/static/docs/commands-reference/get-url.md b/static/docs/commands-reference/get-url.md
@@ -34,14 +34,14 @@ single-purpose command that can be used out of the box after installing DVC.
 
 DVC supports several types of (local or) remote locations (protocols):
 
-| Type    | Discussion                                              | URL format                                 |
-| ------- | ------------------------------------------------------- | ------------------------------------------ |
-| `local` | Local path                                              | `/path/to/local/file`                      |
-| `s3`    | Amazon S3                                               | `s3://mybucket/data.csv`                   |
-| `gs`    | Google Storage                                          | `gs://mybucket/data.csv`                   |
-| `ssh`   | SSH server                                              | `ssh://user@example.com:/path/to/data.csv` |
-| `hdfs`  | HDFS                                                    | `hdfs://user@example.com/path/to/data.csv` |
-| `http`  | HTTP to file with _strong ETag_ (see explanation below) | `https://example.com/path/to/data.csv`     |
+| Type    | Discussion     | URL format                                 |
+| ------- | -------------- | ------------------------------------------ |
+| `local` | Local path     | `/path/to/local/file`                      |
+| `s3`    | Amazon S3      | `s3://mybucket/data.csv`                   |
+| `gs`    | Google Storage | `gs://mybucket/data.csv`                   |
+| `ssh`   | SSH server     | `ssh://user@example.com:/path/to/data.csv` |
+| `hdfs`  | HDFS           | `hdfs://user@example.com/path/to/data.csv` |
+| `http`  | HTTP to file   | `https://example.com/path/to/data.csv`     |
 
 > Depending on the remote locations type you plan to download data from you
 > might need to specify one of the optional dependencies: `[s3]`, `[ssh]`,

diff --git a/static/docs/commands-reference/get.md b/static/docs/commands-reference/get.md
@@ -50,9 +50,9 @@ created in the current working directory, with its original file name.
 > DVC is [installed](/doc/get-started/install).
 
 We can use `dvc get` to download the resulting model file from our
-[get started example](https://github.com/iterative/example-get-started), which
-is a DVC project external to the current working directory). The desired file is
-located in the root of the external repo, and named `model.pkl`.
+[get started example repo](https://github.com/iterative/example-get-started),
+which is a DVC project external to the current working directory). The desired
+file is located in the root of the external repo, and named `model.pkl`.
 
 ```dvc
 $ dvc get https://github.com/iterative/example-get-started model.pkl