Skip to content

Commit

Permalink
get: improve notes about analogy vs. wget, and other related text
Browse files Browse the repository at this point in the history
addresses #912 (comment)
  • Loading branch information
jorgeorpinel committed Jan 16, 2020
1 parent 44e7fca commit 96232e0
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 18 deletions.
3 changes: 1 addition & 2 deletions public/static/docs/command-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Provides an easy way to download files or directories tracked in any <abbr>DVC
project</abbr> (e.g. datasets, intermediate results, ML models), or Git
repository (e.g. source code, small image/other files). `dvc get` copies the
target file or directory (`url`/`path`) to the current working directory. (For
remote URLs, it works like downloading with `wget`, but supporting DVC
<abbr>data artifacts</abbr> and other files tracked in the repository.)
<abbr>DVC repositories</abbr>, it's analogous to `wget`.)

Note that this command doesn't require an existing DVC project to run in. It's a
single-purpose command that can be used out of the box after installing DVC.
Expand Down
10 changes: 5 additions & 5 deletions public/static/docs/get-started/add-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ $ dvc get https://github.com/iterative/dataset-registry \
get-started/data.xml -o data/data.xml
```

> `dvc get` can use any <abbr>DVC project</abbr> hosted on a Git repository to
> find the appropriate [remote storage](/doc/command-reference/remote) and
> download <abbr>data artifacts</abbr> from it. (It works like `wget`, but for
> DVC repositories.) In this case we use
> [dataset-registry](https://github.com/iterative/dataset-registry) as the
> `dvc get` can use any <abbr>DVC project</abbr> to find the appropriate
> [remote storage](/doc/command-reference/remote) and download <abbr>data
> artifacts</abbr> from it. (It's analogous to `wget`, but for <abbr>DVC
> repositories</abbr>.) In this case we use
> [dataset-registry](https://github.com/iterative/dataset-registry)) as the
> source project. (Refer to [Data Registries](/doc/use-cases/data-registries)
> for more info about this setup.)
Expand Down
8 changes: 4 additions & 4 deletions public/static/docs/tutorials/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ $ git add code/
$ git commit -m "Download and add code to new Git repo"
```

> `dvc get` can use any <abbr>DVC project</abbr> hosted on a Git repository to
> find the appropriate [remote storage](/doc/command-reference/remote) and
> download <abbr>data artifacts</abbr> from it. (It works like `wget`, but for
> DVC or Git repositories.) In this case we use
> `dvc get` can use any <abbr>DVC project</abbr> to find the appropriate
> [remote storage](/doc/command-reference/remote) and download <abbr>data
> artifacts</abbr> from it. (It's analogous to `wget`, but for <abbr>DVC
> repositories</abbr>.) In this case we use
> [dataset-registry](https://github.com/iterative/dataset-registry)) as the
> source project. (Refer to [Data Registries](/doc/use-cases/data-registries)
> for more info about this setup.)
Expand Down
8 changes: 4 additions & 4 deletions public/static/docs/tutorials/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ $ unzip -q data.zip
$ rm -f data.zip
```

> `dvc get` can use any <abbr>DVC project</abbr> hosted on a Git repository to
> find the appropriate [remote storage](/doc/command-reference/remote) and
> download <abbr>data artifacts</abbr> from it. (It works like `wget`, but for
> DVC repositories.) In this case we use
> `dvc get` can use any <abbr>DVC project</abbr> to find the appropriate
> [remote storage](/doc/command-reference/remote) and download <abbr>data
> artifacts</abbr> from it. (It's analogous to `wget`, but for <abbr>DVC
> repositories</abbr>.) In this case we use
> [dataset-registry](https://github.com/iterative/dataset-registry)) as the
> source project. (Refer to [Data Registries](/doc/use-cases/data-registries)
> for more info about this setup.)
Expand Down
6 changes: 3 additions & 3 deletions public/static/docs/user-guide/external-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ credentials for the different remotes.

## Example: `import-url` command

In the previous examples, downloading commands were used: `aws s3 cp`, `scp`,
`wget`, etc. `dvc import-url` simplifies the downloading for all the supported
external path or URL types.
In the previous examples, special downloading tools were used: `scp`,
`aws s3 cp`, etc. `dvc import-url` simplifies the downloading for all the
supported external path or URL types.

```dvc
$ dvc import-url https://data.dvc.org/get-started/data.xml
Expand Down

0 comments on commit 96232e0

Please sign in to comment.