From cf744045a7957ef761fb67b903e120753ec675fd Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 21 Jul 2020 22:43:34 -0500 Subject: [PATCH] doc: misc. updates (late July) (#1610) * doc: misc. updates * Update content/docs/use-cases/versioning-data-and-model-files/index.md * cmd: remove comma from remote modify --- content/docs/command-reference/push.md | 4 ++-- .../docs/command-reference/remote/modify.md | 2 +- .../versioning-data-and-model-files/index.md | 2 +- .../docs/user-guide/managing-external-data.md | 21 +++++++++++-------- .../docs/user-guide/updating-tracked-files.md | 2 +- 5 files changed, 17 insertions(+), 14 deletions(-) diff --git a/content/docs/command-reference/push.md b/content/docs/command-reference/push.md index e5b1aacf15..3f259dd944 100644 --- a/content/docs/command-reference/push.md +++ b/content/docs/command-reference/push.md @@ -212,8 +212,8 @@ as you run an experiment locally and push data to remote storage. To set the example consider having created a workspace that contains some code and data, and having set up a remote. -Some work has been performed in the workspace, and it contains new data to -upload onto the [remote](/doc/command-reference/remote). `dvc status --cloud` +Some work has been performed in the workspace, and new data is ready for +uploading to the [remote](/doc/command-reference/remote). `dvc status --cloud` will list several files in `new` state. We can see exactly what that means by looking in the project's cache: diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 8c03c6811e..279a791719 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -480,7 +480,7 @@ more information. $ dvc remote modify --local myremote password mypassword ``` -> The username, and password (may) contain sensitive user info. Therefore, it's +> The username and password (may) contain sensitive user info. Therefore, it's > safer to add them with the `--local` option, so they're written to a > Git-ignored config file. diff --git a/content/docs/use-cases/versioning-data-and-model-files/index.md b/content/docs/use-cases/versioning-data-and-model-files/index.md index 04f96020eb..4bede657db 100644 --- a/content/docs/use-cases/versioning-data-and-model-files/index.md +++ b/content/docs/use-cases/versioning-data-and-model-files/index.md @@ -40,7 +40,7 @@ To start using DVC we need to [initialize](/doc/command-reference/init) a $ dvc init ``` -Start tracking the models and images directory with `dvc add`: +Start tracking the images directory and the model with `dvc add`: ```dvc $ dvc add images diff --git a/content/docs/user-guide/managing-external-data.md b/content/docs/user-guide/managing-external-data.md index 61f232daed..4449b620c0 100644 --- a/content/docs/user-guide/managing-external-data.md +++ b/content/docs/user-guide/managing-external-data.md @@ -52,7 +52,10 @@ The default local cache location is `.dvc/cache`, so there is no need to specify it explicitly. ```dvc -$ dvc add /home/shared/mydata --external +# Add data on an external location directly +$ dvc add --external /home/shared/mydata + +# Create the stage with an external location output $ dvc run -d data.txt \ --external \ -o /home/shared/data.txt \ @@ -69,9 +72,9 @@ $ dvc remote add sshcache ssh://user@example.com:/cache $ dvc config cache.ssh sshcache # Add data on SSH directly -$ dvc add ssh://user@example.com:/mydata --external +$ dvc add --external ssh://user@example.com:/mydata -# Create the stage with external SSH output +# Create the stage with an external SSH output $ dvc run -d data.txt \ --external \ -o ssh://user@example.com:/home/shared/data.txt \ @@ -88,9 +91,9 @@ $ dvc remote add s3cache s3://mybucket/cache $ dvc config cache.s3 s3cache # Add data on S3 directly -$ dvc add s3://mybucket/mydata --external +$ dvc add --external s3://mybucket/mydata -# Create the stage with external S3 output +# Create the stage with an external S3 output $ dvc run -d data.txt \ --external \ -o s3://mybucket/data.txt \ @@ -107,9 +110,9 @@ $ dvc remote add gscache gs://mybucket/cache $ dvc config cache.gs gscache # Add data on GS directly -$ dvc add gs://mybucket/mydata --external +$ dvc add --external gs://mybucket/mydata -# Create the stage with external GS output +# Create the stage with an external GS output $ dvc run -d data.txt \ --external \ -o gs://mybucket/data.txt \ @@ -126,9 +129,9 @@ $ dvc remote add hdfscache hdfs://user@example.com/cache $ dvc config cache.hdfs hdfscache # Add data on HDFS directly -$ dvc add hdfs://user@example.com/mydata --external +$ dvc add --external hdfs://user@example.com/mydata -# Create the stage with external HDFS output +# Create the stage with an external HDFS output $ dvc run -d data.txt \ --external \ -o hdfs://user@example.com/home/shared/data.txt \ diff --git a/content/docs/user-guide/updating-tracked-files.md b/content/docs/user-guide/updating-tracked-files.md index 58220fc1b3..44ce0f16ea 100644 --- a/content/docs/user-guide/updating-tracked-files.md +++ b/content/docs/user-guide/updating-tracked-files.md @@ -12,7 +12,7 @@ link types.) > [issue #599](https://github.com/iterative/dvc/issues/599) in our Github > repository. -Assume `train.tsv` is tracked by dvc and you want to update it. Here updating +Assume `train.tsv` is tracked by DVC and you want to update it. Here updating may mean either replacing `train.tsv` with a new file having the same name or editing the content of the file.