Skip to content

Commit

Permalink
doc: misc. updates (late July) (#1610)
Browse files Browse the repository at this point in the history
* doc: misc. updates

* Update content/docs/use-cases/versioning-data-and-model-files/index.md

* cmd: remove comma from remote modify
  • Loading branch information
jorgeorpinel authored Jul 22, 2020
1 parent 2c3cc7d commit cf74404
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 14 deletions.
4 changes: 2 additions & 2 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ as you run an experiment locally and push data to remote storage. To set the
example consider having created a <abbr>workspace</abbr> 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 <abbr>cache</abbr>:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 12 additions & 9 deletions content/docs/user-guide/managing-external-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -69,9 +72,9 @@ $ dvc remote add sshcache ssh://[email protected]:/cache
$ dvc config cache.ssh sshcache
# Add data on SSH directly
$ dvc add ssh://[email protected]:/mydata --external
$ dvc add --external ssh://[email protected]:/mydata
# Create the stage with external SSH output
# Create the stage with an external SSH output
$ dvc run -d data.txt \
--external \
-o ssh://[email protected]:/home/shared/data.txt \
Expand All @@ -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 \
Expand All @@ -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 \
Expand All @@ -126,9 +129,9 @@ $ dvc remote add hdfscache hdfs://[email protected]/cache
$ dvc config cache.hdfs hdfscache
# Add data on HDFS directly
$ dvc add hdfs://[email protected]/mydata --external
$ dvc add --external hdfs://[email protected]/mydata
# Create the stage with external HDFS output
# Create the stage with an external HDFS output
$ dvc run -d data.txt \
--external \
-o hdfs://[email protected]/home/shared/data.txt \
Expand Down
2 changes: 1 addition & 1 deletion content/docs/user-guide/updating-tracked-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit cf74404

Please sign in to comment.