Skip to content

Commit

Permalink
cmd ref: change Example section to Supported storage types
Browse files Browse the repository at this point in the history
per #803 (review)

and use lower case "Note"
per #803 (review)
  • Loading branch information
jorgeorpinel committed Nov 19, 2019
1 parent c05d04f commit 464aeac
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions static/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ Use `dvc config` to unset/change the default remote as so:

- `-v`, `--verbose` - displays detailed tracing information.

## Examples
## Supported storage types

The following are the types of remote storage (protocols) supported:
These are the possible remote storage (protocols) DVC can work with:

<details>

### Click for a local remote example
### Click for local remote

A "local remote" is a directory in the machine's file system.

Expand Down Expand Up @@ -129,7 +129,7 @@ $ cat .dvc/config

<details>

### Click for Amazon S3 example
### Click for Amazon S3

> **Note!** Before adding a new remote be sure to login into AWS services and
> follow instructions at
Expand Down Expand Up @@ -166,7 +166,7 @@ So, make sure you have the following permissions enabled:

<details>

### Click for S3 API compatible storage example
### Click for S3 API compatible storage

To communicate with a remote object storage that supports an S3 compatible API
(e.g. [Minio](https://min.io/),
Expand Down Expand Up @@ -196,7 +196,7 @@ For more information about the variables DVC supports, please visit

<details>

### Click for Azure example
### Click for Azure

```dvc
$ dvc remote add myremote azure://my-container-name/path
Expand Down Expand Up @@ -234,7 +234,7 @@ $ dvc remote add myremote "azure://"

<details>

### Click for Google Cloud Storage example
### Click for Google Cloud Storage

```dvc
$ dvc remote add myremote gs://bucket/path
Expand All @@ -244,16 +244,16 @@ $ dvc remote add myremote gs://bucket/path

<details>

### Click for SSH example
### Click for SSH

```dvc
$ dvc remote add myremote ssh://[email protected]/path/to/dir
```

> **NOTE!** DVC requires SSH and SFTP access to work properly. Please use `ssh`
> **Note!** DVC requires SSH and SFTP access to work properly. Please use `ssh`
> and `sftp` CLI commands to ensure that you are able to connect to your remote.
> **NOTE!** Your server's SFTP root might differ from the physical root (see
> **Note!** Your server's SFTP root might differ from the physical root (see
> `ChrootDirectory` config option in `/etc/ssh/sshd_config`), in which case you
> have to specify `/path/to/dir` component of the remote url relative to the
> SFTP root and not the physical root. For example, on some Synology NASes your
Expand All @@ -265,13 +265,13 @@ $ dvc remote add myremote ssh://[email protected]/path/to/dir

<details>

### Click for HDFS example
### Click for HDFS

```dvc
$ dvc remote add myremote hdfs://[email protected]/path/to/dir
```

> **NOTE!** If you are seeing `Unable to load libjvm` error on ubuntu with
> **Note!** If you are seeing `Unable to load libjvm` error on ubuntu with
> openjdk-8, try setting JAVA_HOME env variable. This issue is solved in the
> [upstream version of pyarrow](https://github.com/apache/arrow/pull/4907) and
> the fix will be included into the next pyarrow release.
Expand All @@ -280,7 +280,7 @@ $ dvc remote add myremote hdfs://[email protected]/path/to/dir

<details>

### Click for HTTP example
### Click for HTTP

> **Note!** Currently HTTP remotes only support downloads operations:
>
Expand Down

0 comments on commit 464aeac

Please sign in to comment.