From b2bdba845fda9c40bbf3f6ac3b4cba3d1dc03cc2 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 17 Sep 2019 13:34:52 -0400 Subject: [PATCH] get: review instances of `wget` and update around accordingly for #487 --- static/docs/commands-reference/import-url.md | 7 +++---- static/docs/tutorial/define-ml-pipeline.md | 4 ++-- static/docs/tutorial/preparation.md | 7 ++----- static/docs/user-guide/external-dependencies.md | 16 +++++++++------- static/docs/user-guide/external-outputs.md | 2 +- 5 files changed, 17 insertions(+), 19 deletions(-) diff --git a/static/docs/commands-reference/import-url.md b/static/docs/commands-reference/import-url.md index 3a7e4a68b6..6d577b0037 100644 --- a/static/docs/commands-reference/import-url.md +++ b/static/docs/commands-reference/import-url.md @@ -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 diff --git a/static/docs/tutorial/define-ml-pipeline.md b/static/docs/tutorial/define-ml-pipeline.md index 822e150c08..2386d37b9a 100644 --- a/static/docs/tutorial/define-ml-pipeline.md +++ b/static/docs/tutorial/define-ml-pipeline.md @@ -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). diff --git a/static/docs/tutorial/preparation.md b/static/docs/tutorial/preparation.md index eedabed251..8181b66177 100644 --- a/static/docs/tutorial/preparation.md +++ b/static/docs/tutorial/preparation.md @@ -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). diff --git a/static/docs/user-guide/external-dependencies.md b/static/docs/user-guide/external-dependencies.md index 387cab9ccc..76b17835c9 100644 --- a/static/docs/user-guide/external-dependencies.md +++ b/static/docs/user-guide/external-dependencies.md @@ -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 \ @@ -81,13 +81,15 @@ $ dvc run -d hdfs://user@example.com/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 @@ -95,7 +97,7 @@ 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 @@ -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 @@ -120,8 +122,8 @@ Importing 'https://data.dvc.org/get-started/data.xml' -> 'data.xml' ... ``` -The command above creates an import stage specified in DVC-file -`data.xml.dvc` that uses an external dependency (in this case of HTTP type). +The command above creates the import stage (DVC-file) +`data.xml.dvc`, that uses an external dependency (in this case an HTTPs URL).
diff --git a/static/docs/user-guide/external-outputs.md b/static/docs/user-guide/external-outputs.md index 3463db1e09..af6c899fdc 100644 --- a/static/docs/user-guide/external-outputs.md +++ b/static/docs/user-guide/external-outputs.md @@ -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.