Skip to content

Commit

Permalink
get: review instances of wget and update around accordingly
Browse files Browse the repository at this point in the history
for #487
  • Loading branch information
jorgeorpinel committed Sep 17, 2019
1 parent b0b6390 commit b2bdba8
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 19 deletions.
7 changes: 3 additions & 4 deletions static/docs/commands-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,9 @@ directory we created previously. (Its `path` has the URL for the datastore.) And
instead of an `etag` we have an `md5` checksum. We did this so its easy to edit
the data file.

Let's now manually reproduce
[one of the processing chapters](/doc/get-started/connect-code-and-data) from
the _Get Started_ project. Download the example source code archive and unzip
it:
Let's now manually reproduce a
[processing chapter](/doc/get-started/connect-code-and-data) from the _Get
Started_ project. Download the example source code archive and unzip it:

```dvc
$ wget https://code.dvc.org/get-started/code.zip
Expand Down
4 changes: 2 additions & 2 deletions static/docs/tutorial/define-ml-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ files and download a 40MB data archive into this directory.
### Expand to learn how to download on Windows

Windows doesn't include the `wget` utility by default, so you'll need to use the
browser to download `data.xml`. Save it into the `data` subdirectory.
browser to download `data.xml`. Save it into the `data/` subdirectory.
(Right-click [this link](https://data.dvc.org/tutorial/ver/data.zip) and click
`Save link as`(Chrome) or `Save object as`(Firefox)).
`Save Link As...`(Chrome).

</details>

Expand Down
7 changes: 2 additions & 5 deletions static/docs/tutorial/preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@ code into it:
### Expand to learn how to download on Windows

Windows doesn't include the `wget` utility by default, so you'll need to use the
browser to download `code.zip`. Save it into the `classify` directory.
browser to download `code.zip`. Save it into the project directory, `classify/`.
(Right-click [this link](https://code.dvc.org/tutorial/nlp/code.zip) and click
`Save link as`(Chrome) or `Save object as`(Firefox)).

Windows doesn't ship `wget` utility by default, so you'll need to use browser to
download `code.zip`.
`Save Link As...`(Chrome).

</details>

Expand Down
16 changes: 9 additions & 7 deletions static/docs/user-guide/external-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ stage file (DVC-file).
> Note that some of these commands use the `/home/shared` directory, typical in
> Linux distributions.
### Local
### Local file system path

```dvc
$ dvc run -d /home/shared/data.txt \
Expand Down Expand Up @@ -81,21 +81,23 @@ $ dvc run -d hdfs://[email protected]/home/shared/data.txt \

### HTTP

> Including HTTPs
```dvc
$ dvc run -d https://example.com/data.txt \
-o data.txt \
wget https://example.com/data.txt -O data.txt
```

## Example: Defined with DVC remote aliases
## Example: 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
credentials, you may use `dvc remote add` to define this location as a DVC
Remote, and then use a special `remote://{remote_name}/{path}` URL to define an
external dependency.

For example, for an HTTP remote/dependency:
For example, for an HTTPs remote/dependency:

```dvc
$ dvc remote add example https://example.com
Expand All @@ -107,11 +109,11 @@ $ dvc run -d remote://example/data.txt \
Please refer to `dvc remote add` for more details like setting up access
credentials for certain remotes.

## Example: Using import-url
## 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
types of dependencies.
external path or URL types.

```dvc
$ dvc import-url https://data.dvc.org/get-started/data.xml
Expand All @@ -120,8 +122,8 @@ Importing 'https://data.dvc.org/get-started/data.xml' -> 'data.xml'
...
```

The command above creates an <abbr>import stage</abbr> specified in DVC-file
`data.xml.dvc` that uses an external dependency (in this case of HTTP type).
The command above creates the <abbr>import stage</abbr> (DVC-file)
`data.xml.dvc`, that uses an external dependency (in this case an HTTPs URL).

<details>

Expand Down
2 changes: 1 addition & 1 deletion static/docs/user-guide/external-outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ stage file (DVC-file).
> Note that some of these commands use the `/home/shared` directory, typical in
> Linux distributions.
### Local
### Local file system path

The default local cache location is `.dvc/cache`, so there is no need to specify
it explicitly.
Expand Down

0 comments on commit b2bdba8

Please sign in to comment.