diff --git a/pages/doc.js b/pages/doc.js
index 652dcb5f16..4030113bfc 100644
--- a/pages/doc.js
+++ b/pages/doc.js
@@ -129,7 +129,7 @@ export default function Documentation({ item, headings, markdown, errorCode }) {
}
Documentation.getInitialProps = async ({ asPath, req }) => {
- const item = getItemByPath(asPath.split('#')[0].split('?')[0])
+ const item = getItemByPath(asPath.split(/[?#]/)[0])
if (!item) {
return {
diff --git a/public/static/docs/command-reference/add.md b/public/static/docs/command-reference/add.md
index 82b728653a..0e992c116d 100644
--- a/public/static/docs/command-reference/add.md
+++ b/public/static/docs/command-reference/add.md
@@ -87,10 +87,10 @@ reproducible.
## Options
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the files to add by searching
- each target directory and its subdirectories for data files. For each file
- found, a new DVC-file is created using the process described in this command's
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the files to add by searching each
+ target directory and its subdirectories for data files. For each file found, a
+ new DVC-file is created using the process described in this command's
description.
- `--no-commit` - do not save outputs to cache. A DVC-file is created, and an
@@ -197,8 +197,8 @@ Saving information to 'pics.dvc'.
There are no [DVC-files](/doc/user-guide/dvc-file-format) generated within this
directory structure, but the images are all added to the cache. DVC
-prints a message to that effect, mentioning that `md5` values are computed for
-each directory. A single `pics.dvc` DVC-file is generated for the top-level
+prints a message about this, mentioning that `md5` values are computed for each
+directory. A single `pics.dvc` DVC-file is generated for the top-level
directory, and it contains:
```yaml
diff --git a/public/static/docs/command-reference/checkout.md b/public/static/docs/command-reference/checkout.md
index 829f1b1602..5045082b5b 100644
--- a/public/static/docs/command-reference/checkout.md
+++ b/public/static/docs/command-reference/checkout.md
@@ -67,16 +67,16 @@ be pulled from remote storage using `dvc pull`.
## Options
-- `-d`, `--with-deps` - determine files to update by tracking dependencies to
- the target DVC-files (stages). This option only has effect when one or more
- `targets` are specified. By traversing all stage dependencies, DVC searches
- backward from the target stages in the corresponding pipelines. This means DVC
- will not checkout files referenced in later stages than the `targets`.
-
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the files to checkout by
- searching each target directory and its subdirectories for DVC-files to
- inspect.
+- `-d`, `--with-deps` - one or more `targets` should be specified for this
+ option to have effect. Determines files to update by tracking dependencies to
+ the target DVC-files (stages). By traversing all stage dependencies, DVC
+ searches backward from the target stages in the corresponding pipelines. This
+ means DVC will not checkout files referenced in later stages than the
+ `targets`.
+
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the files to checkout by searching
+ each target directory and its subdirectories for DVC-files to inspect.
- `-f`, `--force` - does not prompt when removing workspace files. Changing the
current set of DVC-files with `git checkout` can result in the need for DVC to
diff --git a/public/static/docs/command-reference/commit.md b/public/static/docs/command-reference/commit.md
index 053d6af7ce..2535d40e43 100644
--- a/public/static/docs/command-reference/commit.md
+++ b/public/static/docs/command-reference/commit.md
@@ -68,16 +68,15 @@ reproducibility in those cases.
## Options
-- `-d`, `--with-deps` - determine files to commit by tracking dependencies to
- the target DVC-files (stages). This option only has effect when one or more
- `targets` are specified. By traversing all stage dependencies, DVC searches
- backward from the target stages in the corresponding pipelines. This means DVC
- will not commit files referenced in later stages than the `targets`.
-
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the files to commit by
- searching each target directory and its subdirectories for DVC-files to
- inspect.
+- `-d`, `--with-deps` - one or more `targets` should be specified for this
+ option to have effect. Determines files to commit by tracking dependencies to
+ the target DVC-files (stages). By traversing all stage dependencies, DVC
+ searches backward from the target stages in the corresponding pipelines. This
+ means DVC will not commit files referenced in later stages than the `targets`.
+
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the files to commit by searching
+ each target directory and its subdirectories for DVC-files to inspect.
- `-f`, `--force` - commit data even if checksums for dependencies or outputs
did not change.
diff --git a/public/static/docs/command-reference/config.md b/public/static/docs/command-reference/config.md
index 59ee19a932..29f3d3b47d 100644
--- a/public/static/docs/command-reference/config.md
+++ b/public/static/docs/command-reference/config.md
@@ -110,8 +110,8 @@ for more details.) This section contains the following options:
> directory into paths relative to the config file location.
- `cache.protected` - make files under DVC control read-only. Possible values
- are `true` or `false` (default). Run `dvc checkout` for the change to go into
- effect.
+ are `true` or `false` (default). Run `dvc checkout` after changing the value
+ of this option for the change to go into effect.
Due to the way DVC handles linking between the data files in the cache and
their counterparts in the workspace, it's easy to accidentally
@@ -200,18 +200,19 @@ learn more about the state file (database) that is used for optimization.
$ dvc config core.loglevel debug
```
-## Example: Add an S3 remote
+## Example: Add an S3 remote, and set it as default
> 💡 Before adding an S3 remote, be sure to
> [Create a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html).
-This also sets the remote as the project default:
-
```dvc
$ dvc remote add myremote s3://bucket/path
$ dvc config core.remote myremote
```
+> Note that this is equivalent to using `dvc remote add` with the
+> `-d`/`--default` option.
+
## Example: Default remotes
Use remote `myremote` by default:
diff --git a/public/static/docs/command-reference/fetch.md b/public/static/docs/command-reference/fetch.md
index 9b50b6c910..41d27d692b 100644
--- a/public/static/docs/command-reference/fetch.md
+++ b/public/static/docs/command-reference/fetch.md
@@ -78,16 +78,15 @@ specified in DVC-files currently in the project are considered by `dvc fetch`
`dvc config core.remote`). The argument `REMOTE` is a remote name defined
using the `dvc remote` command.
-- `-d`, `--with-deps` - determine files to download by tracking dependencies to
- the target DVC-files (stages). This option only has effect when one or more
- `targets` are specified. By traversing all stage dependencies, DVC searches
- backward from the target stages in the corresponding pipelines. This means DVC
- will not fetch files referenced in later stages than the `targets`.
-
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the files to fetch by
- searching each target directory and its subdirectories for DVC-files to
- inspect.
+- `-d`, `--with-deps` - one or more `targets` should be specified for this
+ option to have effect. Determines files to download by tracking dependencies
+ to the target DVC-files (stages). By traversing all stage dependencies, DVC
+ searches backward from the target stages in the corresponding pipelines. This
+ means DVC will not fetch files referenced in later stages than the `targets`.
+
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the files to fetch by searching
+ each target directory and its subdirectories for DVC-files to inspect.
- `-j JOBS`, `--jobs JOBS` - number of threads to run simultaneously to handle
the downloading of files from the remote. Using more jobs may improve the
diff --git a/public/static/docs/command-reference/get.md b/public/static/docs/command-reference/get.md
index 27eddb42d8..05c654065f 100644
--- a/public/static/docs/command-reference/get.md
+++ b/public/static/docs/command-reference/get.md
@@ -19,10 +19,10 @@ positional arguments:
## Description
Provides an easy way to download files or directories tracked in any DVC
-project (e.g. datasets, ML models), or Git repository (e.g. source code,
-small images or data files). The file or directory in path is copied to the
-current working directory. (For remote URLs, it works like downloading with
-wget, but supporting DVC data artifacts and files tracked by Git.)
+project (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
+DVC repositories, 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.
@@ -35,11 +35,11 @@ doesn't have a default remote set up, instead of downloading, DVC will try to
copy the target data from the external source project or its
cache).
-The `path` argument of this command is used to specify the location, within the
-source project or repository at `url`, of the target(s) to be downloaded. It can
-point to any file or directory in the source project, including outputs
- tracked by DVC as well as files tracked by Git. Note that for the
-former, data should be specified in one of the
+The `path` argument of this command is used to specify the location of the
+target(s) to be downloaded within the source project or repository at `url`. It
+can point to any file or directory in the source project, including
+outputs tracked by DVC as well as files tracked by Git. Note that
+for the former, data should be specified in one of the
[DVC-files](/doc/user-guide/dvc-file-format) of the source repository. (In this
case, a default [DVC remote](/doc/command-reference/remote) needs to be
configured in the project, containing the actual data.)
@@ -58,11 +58,12 @@ name.
an existing directory is specified, then the output will be placed inside of
it.
-- `--rev` - specific
+- `--rev` - `url` is expected to represent a Git repository for this option to
+ have an effect. Specific
[Git revision](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
- (such as a branch name, a tag, or a commit hash) of the Git repository to
- download the file or directory from. The tip of the default branch is used by
- default when this option is not specified.
+ (such as a branch name, a tag, or a commit hash) of the repository to download
+ the file or directory from. The tip of the default branch is used by default
+ when this option is not specified.
- `-h`, `--help` - prints the usage/help message, and exit.
@@ -107,9 +108,9 @@ The same example applies to raw or intermediate data artifacts as
well, of course, for cases where we want to download those files or directories
and perform some analysis on them.
-## Examples: Get a Git-tracked model file
+## Examples: Get a misc. Git-tracked file
-We can also use `dvc get` to retrieve any file or directory that exists in a git
+We can also use `dvc get` to retrieve any file or directory that exists in a Git
repository.
```dvc
diff --git a/public/static/docs/command-reference/import.md b/public/static/docs/command-reference/import.md
index fc6cb0f529..19c09a2806 100644
--- a/public/static/docs/command-reference/import.md
+++ b/public/static/docs/command-reference/import.md
@@ -23,10 +23,10 @@ positional arguments:
Provides an easy way to reuse files or directories tracked in any DVC
project (e.g. datasets, intermediate results, ML models) or Git
-repository (e.g. other files and directories), into the workspace. The
-`dvc import` command downloads such a data artifact in a way that
-it is tracked with DVC, so it can be updated when the data source changes. (See
-`dvc update`.)
+repository (e.g. source code, small image/other files). `dvc import` downloads
+the target file or directory (`url`/`path`) in a way so that it's tracked with
+DVC, becoming a local data artifact. This also permits updating the
+import later, if it has changed in its data source. (See `dvc update`.)
The `url` argument specifies the address of the DVC project or Git
repository containing the data source. Both HTTP and SSH protocols are supported
@@ -36,11 +36,11 @@ doesn't have a default remote set up, instead of downloading, DVC will try to
copy the target data from the external source project or its
cache).
-The `path` argument of this command is used to specify the location, within the
-source project or repository at `url`, of the target(s) to be downloaded. It can
-point to any file or directory in the source project, including outputs
- tracked by DVC as well as files tracked by Git. Note that for the
-former, data should be specified in one of the
+The `path` argument of this command is used to specify the location of the
+target(s) to be downloaded within the source project or repository at `url`. It
+can point to any file or directory in the source project, including
+outputs tracked by DVC as well as files tracked by Git. Note that
+for the former, data should be specified in one of the
[DVC-files](/doc/user-guide/dvc-file-format) of the source repository. (In this
case, a default [DVC remote](/doc/command-reference/remote) needs to be
configured in the project, containing the actual data.)
@@ -75,13 +75,16 @@ data artifact from the source project.
an existing directory is specified, then the output will be placed inside of
it.
-- `--rev` - specific
+- `--rev` - `url` is expected to represent a Git repository for this option to
+ have an effect. Specific
[Git revision](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
- (such as a branch name, a tag, or a commit hash) of the Git repository to
- import the data from. The tip of the repository's default branch is used by
- default when this option is not specified. Note that this adds a `rev` field
- in the import stage that fixes it to this revision. This can impact the
- behavior of `dvc update`. (See **re-importing** example below.)
+ (such as a branch name, a tag, or a commit hash) of the repository to download
+ the file or directory from. The tip of the default branch is used by default
+ when this option is not specified.
+
+ > Note that this adds a `rev` field in the import stage that fixes it to this
+ > revision. This can impact the behavior of `dvc update`. (See
+ > **re-importing** example below.)
- `-h`, `--help` - prints the usage/help message, and exit.
@@ -130,7 +133,7 @@ Several of the values above are pulled from the original stage file
subfields under `repo` are used to save the origin and version of the
dependency.
-## Example: fixed revisions & re-importing
+## Example: Fixed revisions & re-importing
To import a specific revision of a data artifact, we may use the
`--rev` option:
diff --git a/public/static/docs/command-reference/metrics/show.md b/public/static/docs/command-reference/metrics/show.md
index a41c783d2b..4b10e378fe 100644
--- a/public/static/docs/command-reference/metrics/show.md
+++ b/public/static/docs/command-reference/metrics/show.md
@@ -89,9 +89,10 @@ extension.)
Similar to `-a` above. Note that both options can be combined, for example
using the `-aT` flag.
-- `-R`, `--recursive` - `path` is expected to be a directory for this option to
- have effect. Determines the metric files to show by searching each target
- directory and its subdirectories for DVC-files to inspect.
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the metric files to show by
+ searching each target directory and its subdirectories for DVC-files to
+ inspect.
- `-h`, `--help` - prints the usage/help message, and exit.
diff --git a/public/static/docs/command-reference/pull.md b/public/static/docs/command-reference/pull.md
index 482e82b69e..43a27f3300 100644
--- a/public/static/docs/command-reference/pull.md
+++ b/public/static/docs/command-reference/pull.md
@@ -72,15 +72,15 @@ reflinks or hardlinks to put it in the workspace without copying. See
to save different experiments or project checkpoints. Note that both options
can be combined, for example using the `-aT` flag.
-- `-d`, `--with-deps` - determines files to download by tracking dependencies to
- the target DVC-files (stages). This option only has effect when one or more
- `targets` are specified. By traversing all stage dependencies, DVC searches
- backward from the target stages in the corresponding pipelines. This means DVC
- will not pull files referenced in later stages than the `targets`.
+- `-d`, `--with-deps` - one or more `targets` should be specified for this
+ option to have effect. Determines files to download by tracking dependencies
+ to the target DVC-files (stages). By traversing all stage dependencies, DVC
+ searches backward from the target stages in the corresponding pipelines. This
+ means DVC will not pull files referenced in later stages than the `targets`.
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the files to pull by searching
- each target directory and its subdirectories for DVC-files to inspect.
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the files to pull by searching each
+ target directory and its subdirectories for DVC-files to inspect.
- `-f`, `--force` - does not prompt when removing workspace files, which occurs
when these file no longer match the current DVC-file references. This option
@@ -103,19 +103,18 @@ reflinks or hardlinks to put it in the workspace without copying. See
## Examples
For using the `dvc pull` command, a remote storage must be defined. (See
-`dvc remote`.) For an existing project, remotes are usually already
-set up and you can use `dvc remote list` to check them. Just to remind how it is
-done and set a context for the example, let's define an SSH remote with the
-`dvc remote add` command:
+`dvc remote add`.) For an existing project, remotes are usually
+already set up and you can use `dvc remote list` to check them. To remember how
+it's done, and set a context for the example, let's define a default SSH remote:
```dvc
-$ dvc remote add r1 ssh://_username_@_host_/path/to/dvc/remote/storage
+$ dvc remote add -d r1 ssh://_username_@_host_/path/to/dvc/remote/storage
$ dvc remote list
r1 ssh://_username_@_host_/path/to/dvc/remote/storage
```
-> DVC supports several remote types. For details, see the
-> [`remote add`](/doc/command-reference/remote/add) documentation.
+> DVC supports several
+> [remote types](/doc/command-reference/remote/add#supported-storage-types).
Having some images and other files in remote storage, we can pull all changed
files from the current Git branch:
diff --git a/public/static/docs/command-reference/push.md b/public/static/docs/command-reference/push.md
index 629c9fc2dc..3b73ba2bcd 100644
--- a/public/static/docs/command-reference/push.md
+++ b/public/static/docs/command-reference/push.md
@@ -81,15 +81,15 @@ to push.
to save different experiments or project checkpoints. Note that both options
can be combined, for example using the `-aT` flag.
-- `-d`, `--with-deps` - determines files to upload by tracking dependencies to
- the target DVC-files (stages). This option only has effect when one or more
- `targets` are specified. By traversing all stage dependencies, DVC searches
- backward from the target stages in the corresponding pipelines. This means DVC
- will not push files referenced in later stages than the `targets`.
+- `-d`, `--with-deps` - one or more `targets` should be specified for this
+ option to have effect. Determines files to upload by tracking dependencies to
+ the target DVC-files (stages). By traversing all stage dependencies, DVC
+ searches backward from the target stages in the corresponding pipelines. This
+ means DVC will not push files referenced in later stages than the `targets`.
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the files to push by searching
- each target directory and its subdirectories for DVC-files to inspect.
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the files to push by searching each
+ target directory and its subdirectories for DVC-files to inspect.
- `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously
while uploading files to the remote. The effect is to control the number of
@@ -107,10 +107,9 @@ to push.
## Examples
For using the `dvc push` command, a remote storage must be defined. (See
-`dvc remote`.) For an existing project, remotes are usually already
-set up and you can use `dvc remote list` to check them. Just to remind how it is
-done and set a context for the example, let's define an SSH remote with the
-`dvc remote add` command:
+`dvc remote add`.) For an existing project, remotes are usually
+already set up and you can use `dvc remote list` to check them. To remember how
+it's done, and set a context for the example, let's define a default SSH remote:
```dvc
$ dvc remote add r1 ssh://_username_@_host_/path/to/dvc/cache/directory
@@ -118,8 +117,8 @@ $ dvc remote list
r1 ssh://_username_@_host_/path/to/dvc/cache/directory
```
-> DVC supports several remote types. For details, see the
-> [`remote add`](/doc/command-reference/remote/add) documentation.
+> DVC supports several
+> [remote types](/doc/command-reference/remote/add#supported-storage-types).
Push all data file caches from the current Git branch to the default remote:
diff --git a/public/static/docs/command-reference/remote/add.md b/public/static/docs/command-reference/remote/add.md
index 3bee64de95..c6dbd6166d 100644
--- a/public/static/docs/command-reference/remote/add.md
+++ b/public/static/docs/command-reference/remote/add.md
@@ -132,10 +132,10 @@ To communicate with a remote object storage that supports an S3 compatible API
[IBM Cloud Object Storage](https://www.ibm.com/cloud/object-storage) etc.) you
must explicitly set the `endpointurl` in the configuration:
-For example:
+For example, using `dvc remote modify`:
```dvc
-$ dvc remote add -d myremote s3://mybucket/path/to/dir
+$ dvc remote add myremote s3://mybucket/path/to/dir
$ dvc remote modify myremote endpointurl https://object-storage.example.com
```
@@ -217,28 +217,24 @@ $ dvc remote modify myremote gdrive_client_id my_gdrive_client_id
$ dvc remote modify myremote gdrive_client_secret gdrive_client_secret
```
-On first usage of remote you will be prompted to visit access token generation
-link in browser. It will ask you to log into Google account associated with
-Google Drive, which you want to use as DVC's remote. Login process will guide
-you through granting Google Drive access permissions to the used Google Project.
+On first usage of the remote you will be prompted to visit an access token
+generation URL via browser. It will ask you to log into the Google account
+associated with the Google Drive you want to use as remote. The login process
+will guide you through the granting of the required access permissions.
-On successful access token generation, token data will be cached in git ignored
-directory with path `.dvc/tmp/gdrive-user-credentials.json`. Do not share token
-data with anyone else to prevent unauthorized access to your Google Drive.
+On successful access token generation, the token data will be cached in a
+Git-ignored directory (located in `.dvc/tmp/gdrive-user-credentials.json`).
-#### Shared drives support
+> 💡 Do not share the token data with anyone else to prevent unauthorized access
+> to your Google Drive.
-You need to obtain `id` of your shared drive directory to use it as part of URL
-passed to DVC. `id` can be found in your web browser address bar when shared
-drive is opened. For example, for the URL
-
-```dvc
-https://drive.google.com/drive/folders/0AIac4JZqHhKmUk9PDA
-```
+**Support for shared drives**
-the `id` will be equal to `0AIac4JZqHhKmUk9PDA`.
-
-Use obtained `id` in remote's URL:
+For this, you need to obtain the directory ID and use it as part of URL passed
+to DVC. This ID can be found in your web browser address bar when the shared
+drive is opened. For example, for the URL
+`https://drive.google.com/drive/folders/0AIac4JZqHhKmUk9PDA`, use
+`0AIac4JZqHhKmUk9PDA` as ID:
```dvc
$ dvc remote add myremote gdrive://0AIac4JZqHhKmUk9PDA/my-dvc-root
@@ -287,19 +283,15 @@ $ export OSS_ACCESS_KEY_SECRET="my-key-secret"
$ export OSS_ENDPOINT="endpoint"
```
-#### Test your OSS storage using docker
+**Testing your OSS storage using docker**
-Start a container running an OSS emulator.
+Start a container running an OSS emulator, and setup the environment variables,
+for example:
```dvc
$ git clone https://github.com/nanaya-tachibana/oss-emulator.git
$ docker image build -t oss:1.0 oss-emulator
$ docker run --detach -p 8880:8880 --name oss-emulator oss:1.0
-```
-
-Setup environment variables.
-
-```dvc
$ export OSS_BUCKET='my-bucket'
$ export OSS_ENDPOINT='localhost:8880'
$ export OSS_ACCESS_KEY_ID='AccessKeyID'
@@ -398,10 +390,13 @@ $ cat .dvc/config
-## Example: Custom configuration of an S3 remote
+## Example: Customize an S3 remote
Add an Amazon S3 remote as the _default_ (via `-d` option), and modify its
-region:
+region.
+
+> 💡 Before adding an S3 remote, be sure to
+> [Create a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html).
```dvc
$ dvc remote add -d myremote s3://mybucket/myproject
diff --git a/public/static/docs/command-reference/remote/index.md b/public/static/docs/command-reference/remote/index.md
index 7e018cd6e7..cbe8a8947c 100644
--- a/public/static/docs/command-reference/remote/index.md
+++ b/public/static/docs/command-reference/remote/index.md
@@ -80,10 +80,10 @@ project/repository itself. Read "local, but external" storage.
+We use the `-d` (`--default`) option of `dvc remote add` for this:
+
```dvc
$ dvc remote add -d myremote /path/to/remote
-$ dvc remote list
-myremote /path/to/remote
```
The project's config file should now look like this:
@@ -95,18 +95,38 @@ url = /path/to/remote
remote = myremote
```
-## Example: Add a default Amazon S3 remote and modify its region
+## Example: Customize an additional S3 remote
> 💡 Before adding an S3 remote, be sure to
> [Create a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html).
```dvc
-$ dvc remote add -d mynewremote s3://mybucket/myproject
-$ dvc remote modify mynewremote region us-east-2
+$ dvc remote add newremote s3://mybucket/myproject
+$ dvc remote modify newremote endpointurl https://object-storage.example.com
+```
+
+The project's config file should now look something like this:
+
+```ini
+['remote "myremote"']
+url = /path/to/remote
+[core]
+remote = myremote
+['remote "newremote"']
+url = s3://mybucket/myproject
+endpointurl = https://object-storage.example.com
+```
+
+## Example: List all remotes in the project
+
+```dvc
+$ dvc remote list
+myremote /path/to/remote
+newremote s3://mybucket/myproject
```
-## Example: Remove remote:
+## Example: Remove a remote
```dvc
-$ dvc remote remove mynewremote
+$ dvc remote remove newremote
```
diff --git a/public/static/docs/command-reference/remote/list.md b/public/static/docs/command-reference/remote/list.md
index 67e9a6fd46..fa01afee72 100644
--- a/public/static/docs/command-reference/remote/list.md
+++ b/public/static/docs/command-reference/remote/list.md
@@ -38,7 +38,7 @@ including names and URLs.
## Examples
-Let's for simplicity add a default local remote:
+Let's for simplicity add a _default_ local remote:
@@ -60,6 +60,7 @@ And now the list of remotes should look like:
```dvc
$ dvc remote list
-
-myremote /path/to/remote
+myremote /path/to/remote
```
+
+The list will also include any previously added remotes.
diff --git a/public/static/docs/command-reference/remote/modify.md b/public/static/docs/command-reference/remote/modify.md
index cb235aba52..b2cac198bd 100644
--- a/public/static/docs/command-reference/remote/modify.md
+++ b/public/static/docs/command-reference/remote/modify.md
@@ -185,7 +185,7 @@ must explicitly set the `endpointurl` in the configuration:
For example:
```dvc
-$ dvc remote add -d myremote s3://path/to/dir
+$ dvc remote add myremote s3://path/to/dir
$ dvc remote modify myremote endpointurl https://object-storage.example.com
```
@@ -382,26 +382,28 @@ For more information on configuring Azure Storage connection strings, visit
## Example: Customize an S3 remote
-Let's first set up a _default_ S3 remote:
+Let's first set up a _default_ S3 remote.
-```dvc
-$ dvc remote add -d myremote s3://mybucket/storage
+> 💡 Before adding an S3 remote, be sure to
+> [Create a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html).
+```dvc
+$ dvc remote add -d myremote s3://mybucket/myproject
Setting 'myremote' as a default remote.
```
-Modify its endpoint URL:
+Modify its access profile:
```dvc
-$ dvc remote modify myremote endpointurl https://object-storage.example.com
+$ dvc remote modify myremote profile myusername
```
-Now the config file should look like (run `cat .dvc/config`):
+Now the project config file should look like this:
```ini
['remote "myremote"']
url = s3://mybucket/storage
-endpointurl = https://object-storage.example.com
+profile = myusername
[core]
remote = myremote
```
diff --git a/public/static/docs/command-reference/remote/remove.md b/public/static/docs/command-reference/remote/remove.md
index 0028eedb2e..d69028876b 100644
--- a/public/static/docs/command-reference/remote/remove.md
+++ b/public/static/docs/command-reference/remote/remove.md
@@ -47,14 +47,13 @@ edit config files manually.
## Examples
-Add Amazon S3 remote and modify its region:
+Add Amazon S3 remote:
```dvc
$ dvc remote add myremote s3://mybucket/myproject
-$ dvc remote modify myremote region us-east-2
```
-Remove remote:
+Remove it:
```dvc
$ dvc remote remove myremote
diff --git a/public/static/docs/command-reference/repro.md b/public/static/docs/command-reference/repro.md
index 729645abbd..80e4999e4a 100644
--- a/public/static/docs/command-reference/repro.md
+++ b/public/static/docs/command-reference/repro.md
@@ -95,8 +95,8 @@ and only execute the final stage.
reproduced as part of the pipeline in the parent directory, or as an
independent unit.
-- `-R`, `--recursive` - `targets` is expected to contain at least one directory
- path for this option to have effect. Determines the stages to reproduce by
+- `-R`, `--recursive` - `targets` is expected to contain one or more directories
+ for this option to have effect. Determines the stages to reproduce by
searching each target directory and its subdirectories for DVC-files to
inspect.
diff --git a/public/static/docs/command-reference/run.md b/public/static/docs/command-reference/run.md
index 0148e4402d..49eb29ca3e 100644
--- a/public/static/docs/command-reference/run.md
+++ b/public/static/docs/command-reference/run.md
@@ -143,8 +143,8 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.)
confirmation.
- `--ignore-build-cache` - This options has an effect if an equivalent stage
- file exists (same dependencies, outputs, and `command` to execute) which has
- been already executed and is up to date. In this case, `dvc run` won't
+ file exists (same dependencies, outputs, and `command` to execute), that has
+ been already executed, and is up to date. In this case, `dvc run` won't
normally execute the `command` again. The exception is when the existing stage
is considered always changed (see `--always-changed` option). This option
gives a way to forcefully execute the `command` anyway. Useful if the
diff --git a/public/static/docs/command-reference/status.md b/public/static/docs/command-reference/status.md
index eb48971da2..559d149d21 100644
--- a/public/static/docs/command-reference/status.md
+++ b/public/static/docs/command-reference/status.md
@@ -98,12 +98,12 @@ workspace) is different from remote storage. Bringing the two into sync requires
## Options
-- `-d`, `--with-deps` - determines files to check by tracking dependencies to
- the target DVC-files (stages). This option only has effect when one or more
- `targets` are specified. By traversing all stage dependencies, DVC searches
- backward from the target stages in the corresponding pipelines. This means DVC
- will not show changes occurring in later stages than the `targets`. Applies
- whether or not `--cloud` is specified.
+- `-d`, `--with-deps` - one or more `targets` should be specified for this
+ option to have effect. Determines files to check by tracking dependencies to
+ the target DVC-files (stages). By traversing all stage dependencies, DVC
+ searches backward from the target stages in the corresponding pipelines. This
+ means DVC will not show changes occurring in later stages than the `targets`.
+ Applies whether or not `--cloud` is specified.
- `-c`, `--cloud` - enables comparison against a remote. (See `dvc remote`.). If
no `--remote` option has been given, DVC will compare against the default
diff --git a/public/static/docs/command-reference/version.md b/public/static/docs/command-reference/version.md
index 5f6d839053..b1f3c8fabe 100644
--- a/public/static/docs/command-reference/version.md
+++ b/public/static/docs/command-reference/version.md
@@ -34,7 +34,7 @@ system/environment:
> report file system information. Please see the original
> [issue on GitHub](https://github.com/iterative/dvc/issues/2284) for more info.
-#### Components of DVC version
+### Components of DVC version
The detail of DVC version depends upon the way of installing DVC.
@@ -58,7 +58,7 @@ The detail of DVC version depends upon the way of installing DVC.
following part is the latest `master` branch commit hash. The optional suffix
`.mod` means that code is modified.
-#### What we mean by "Binary"
+### What we mean by "Binary"
The detail of `Binary` depends on the way DVC was downloaded and
[installed](/doc/install).
diff --git a/public/static/docs/get-started/add-files.md b/public/static/docs/get-started/add-files.md
index ee790008f1..63f7521b9c 100644
--- a/public/static/docs/get-started/add-files.md
+++ b/public/static/docs/get-started/add-files.md
@@ -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 DVC project hosted on a Git repository to
-> find the appropriate [remote storage](/doc/command-reference/remote) and
-> download data artifacts 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 DVC project to find the appropriate
+> [remote storage](/doc/command-reference/remote) and download data
+> artifacts from it. (It's analogous to `wget`, but for DVC
+> repositories.) 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.)
diff --git a/public/static/docs/tutorials/pipelines.md b/public/static/docs/tutorials/pipelines.md
index 70d2fdc958..6674879b5a 100644
--- a/public/static/docs/tutorials/pipelines.md
+++ b/public/static/docs/tutorials/pipelines.md
@@ -48,10 +48,10 @@ $ git add code/
$ git commit -m "Download and add code to new Git repo"
```
-> `dvc get` can use any DVC project hosted on a Git repository to
-> find the appropriate [remote storage](/doc/command-reference/remote) and
-> download data artifacts from it. (It works like `wget`, but for
-> DVC or Git repositories.) In this case we use
+> `dvc get` can use any DVC project to find the appropriate
+> [remote storage](/doc/command-reference/remote) and download data
+> artifacts from it. (It's analogous to `wget`, but for DVC
+> repositories.) 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.)
diff --git a/public/static/docs/tutorials/versioning.md b/public/static/docs/tutorials/versioning.md
index 680aeef68d..9279d31e14 100644
--- a/public/static/docs/tutorials/versioning.md
+++ b/public/static/docs/tutorials/versioning.md
@@ -83,10 +83,10 @@ $ unzip -q data.zip
$ rm -f data.zip
```
-> `dvc get` can use any DVC project hosted on a Git repository to
-> find the appropriate [remote storage](/doc/command-reference/remote) and
-> download data artifacts from it. (It works like `wget`, but for
-> DVC repositories.) In this case we use
+> `dvc get` can use any DVC project to find the appropriate
+> [remote storage](/doc/command-reference/remote) and download data
+> artifacts from it. (It's analogous to `wget`, but for DVC
+> repositories.) 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.)
diff --git a/public/static/docs/use-cases/data-registries.md b/public/static/docs/use-cases/data-registries.md
index a52340f3a8..a2cb55f8a5 100644
--- a/public/static/docs/use-cases/data-registries.md
+++ b/public/static/docs/use-cases/data-registries.md
@@ -82,7 +82,7 @@ The actual data is stored in the project's cache and should be
be accessed from other locations or by other people:
```
-$ dvc remote add myremote s3://bucket/path
+$ dvc remote add -d myremote s3://bucket/path
$ dvc push
```
diff --git a/public/static/docs/user-guide/contributing/core.md b/public/static/docs/user-guide/contributing/core.md
index b5bbebfd7b..381a06f15d 100644
--- a/public/static/docs/user-guide/contributing/core.md
+++ b/public/static/docs/user-guide/contributing/core.md
@@ -57,10 +57,6 @@ $ source .env/bin/activate
$ pip install -e ".[all,tests]"
```
-> Note that the double quotes (`""`) used to wrap the dependencies to be
-> installed are only compulsory when using `zsh`. In `bash`, installation
-> commands can work without them: `pip install -e .[all,tests]`.
-
Install coding style pre-commit hooks with:
```dvc
diff --git a/public/static/docs/user-guide/external-dependencies.md b/public/static/docs/user-guide/external-dependencies.md
index ee290291f2..36b8a8672a 100644
--- a/public/static/docs/user-guide/external-dependencies.md
+++ b/public/static/docs/user-guide/external-dependencies.md
@@ -110,11 +110,11 @@ $ dvc run -d remote://example/data.txt \
Please refer to `dvc remote add` for more details like setting up access
credentials for the different remotes.
-## Example: import-url command
+## 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
diff --git a/public/static/docs/user-guide/managing-external-data.md b/public/static/docs/user-guide/managing-external-data.md
index b2c7c91fa9..27a330dded 100644
--- a/public/static/docs/user-guide/managing-external-data.md
+++ b/public/static/docs/user-guide/managing-external-data.md
@@ -68,7 +68,7 @@ $ dvc run -d data.txt \
# Add SSH remote to be used as cache location for SSH files
$ dvc remote add sshcache ssh://user@example.com:/cache
-# Tell dvc to use the 'sshcache' remote as SSH cache location
+# Tell DVC to use the 'sshcache' remote as SSH cache location
$ dvc config cache.ssh sshcache
# Add data on SSH directly
@@ -86,7 +86,7 @@ $ dvc run -d data.txt \
# Add S3 remote to be used as cache location for S3 files
$ dvc remote add s3cache s3://mybucket/cache
-# Tell dvc to use the 's3cache' remote as S3 cache location
+# Tell DVC to use the 's3cache' remote as S3 cache location
$ dvc config cache.s3 s3cache
# Add data on S3 directly
@@ -104,7 +104,7 @@ $ dvc run -d data.txt \
# Add GS remote to be used as cache location for GS files
$ dvc remote add gscache gs://mybucket/cache
-# Tell dvc to use the 'gscache' remote as GS cache location
+# Tell DVC to use the 'gscache' remote as GS cache location
$ dvc config cache.gs gscache
# Add data on GS directly
@@ -122,7 +122,7 @@ $ dvc run -d data.txt \
# Add HDFS remote to be used as cache location for HDFS files
$ dvc remote add hdfscache hdfs://user@example.com/cache
-# Tell dvc to use the 'hdfscache' remote as HDFS cache location
+# Tell DVC to use the 'hdfscache' remote as HDFS cache location
$ dvc config cache.hdfs hdfscache
# Add data on HDFS directly
diff --git a/public/static/docs/user-guide/running-dvc-on-windows.md b/public/static/docs/user-guide/running-dvc-on-windows.md
index f2b79af9cb..c88f7118f9 100644
--- a/public/static/docs/user-guide/running-dvc-on-windows.md
+++ b/public/static/docs/user-guide/running-dvc-on-windows.md
@@ -10,10 +10,17 @@ workarounds that can help avoid these potential problems:
Many of the DVC commands have POSIX-style options that are given with a double
dash `--`. This isn't supported by the simple Windows command prompt `cmd`.
-We recommend [Git Bash](https://gitforwindows.org/#bash) or
-[Anaconda Prompt](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-prompt-win).
-Its even possible to enjoy a full Linux terminal experience with the
+Common Windows terminal alternatives are
+[Git Bash](https://gitforwindows.org/#bash) or
+[Anaconda Prompt](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-prompt-win)
+– but they may not support all the POSIX features (e.g. `\` line continuation).
+
+💡 We recommend the full [Cmder](https://cmder.net/) console emulator (which
+already includes _Git for Windows_).
+
+Its also possible to enjoy a full Linux terminal experience with the
[WSL](https://blogs.windows.com/windowsdeveloper/2016/03/30/run-bash-on-ubuntu-on-windows/)
+– but it may not be possible to access GPUs from this subsystem.
## Disable short-file name generation
diff --git a/server.js b/server.js
index 7452c46d26..d0554acbb3 100644
--- a/server.js
+++ b/server.js
@@ -40,14 +40,9 @@ app.prepare().then(() => {
res.end()
} else if (req.headers.host === 'man.dvc.org') {
// man.dvc.org/{cmd} -> dvc.org/doc/command-reference/{cmd},
- res.writeHead(301, {
+ res.writeHead(303, {
'Cache-Control': 'no-cache',
- Location:
- 'https://dvc.org/doc/command-reference' +
- // replace - for / in {cmd} except for get-url, import-url
- (['/get-url', '/import-url'].indexOf(pathname) < 0
- ? pathname.replace('-', '/')
- : pathname)
+ Location: 'https://dvc.org/doc/command-reference' + pathname
})
res.end()
} else if (req.headers.host === 'error.dvc.org') {
@@ -61,7 +56,7 @@ app.prepare().then(() => {
res.end()
} else if (/^(code|data|remote)\.dvc\.org$/.test(req.headers.host)) {
// {code/data/remote}.dvc.org -> corresponding S3 bucket
- res.writeHead(301, {
+ res.writeHead(303, {
Location:
'https://s3-us-east-2.amazonaws.com/dvc-public/' +
req.headers.host.split('.')[0] +
@@ -70,7 +65,7 @@ app.prepare().then(() => {
res.end()
} else if (/^\/(deb|rpm)\/.*/i.test(pathname)) {
// path /(deb|rpm)/... -> corresponding S3 bucket
- res.writeHead(301, {
+ res.writeHead(303, {
Location:
'https://s3-us-east-2.amazonaws.com/dvc-s3-repo/' +
pathname.substring(1)
@@ -78,7 +73,7 @@ app.prepare().then(() => {
res.end()
} else if (/^\/(help|chat)\/?$/i.test(pathname)) {
// path /(help|chat) -> Discord chat invite
- res.writeHead(301, { Location: 'https://discordapp.com/invite/dvwXA2N' })
+ res.writeHead(303, { Location: 'https://discordapp.com/invite/dvwXA2N' })
res.end()
} else if (/^\/(docs|documentation)(\/.*)?$/i.test(pathname)) {
// path /docs... or /documentation... -> /doc...
diff --git a/src/LandingHero/index.js b/src/LandingHero/index.js
index e13507ea8e..fa2af551ed 100644
--- a/src/LandingHero/index.js
+++ b/src/LandingHero/index.js
@@ -91,7 +91,7 @@ export default class LandingHero extends Component {
$ dvc run -d images -o model.p cnn.py
- $ dvc remote add myrepo s3://mybucket
+ $ dvc remote add -d myrepo s3://mybucket
$ dvc push