Skip to content

Commit

Permalink
Unhide the sections of remote options
Browse files Browse the repository at this point in the history
  • Loading branch information
dashohoxha committed Dec 1, 2019
1 parent b4801e9 commit 6ed975b
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 49 deletions.
6 changes: 1 addition & 5 deletions static/docs/user-guide/remotes/amazon.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,7 @@ $ dvc remote modify s3remote url s3://mybucket/new-path
By default DVC expects your AWS CLI is already
[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).

<details>

### Details: Override default AWS credentials
### Override default AWS credentials

DVC will be using default AWS credentials file to access S3. To override some of
these settings, you could use the following options:
Expand Down Expand Up @@ -113,5 +111,3 @@ these settings, you could use the following options:
```dvc
$ dvc remote modify s3remote acl bucket-owner-full-control
```

</details>
6 changes: 1 addition & 5 deletions static/docs/user-guide/remotes/gs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ The configuration file `.dvc/config` should have a content like this:
url = gs://bucket/path
```

<details>

### Details: GS available options
### GS available options

- `projectname` - project name to use.

Expand All @@ -36,5 +34,3 @@ url = gs://bucket/path
$ dvc remote modify myremote \
credentialpath /path/to/my/creds/[FILE_NAME].json
```

</details>
6 changes: 1 addition & 5 deletions static/docs/user-guide/remotes/hdfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,10 @@ The configuration file `.dvc/config` should have a content like this:
url = hdfs://[email protected]/path/to/dir
```

<details>

### Details: HDFS available options
### HDFS available options

- `user` - username to use to access a remote.

```dvc
$ dvc remote modify myremote user myuser
```

</details>
4 changes: 2 additions & 2 deletions static/docs/user-guide/remotes/http.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# HTTP/HTTPS

> **❗ Note:** HTTP/HTTPS remotes support only download operations.
We can create an HTTPS remote with `dvc remote add`:

```dvc
Expand All @@ -14,3 +12,5 @@ The configuration file `.dvc/config` should have a content like this:
['remote "get-started"']
url = https://data.dvc.org/get-started
```

> **❗ Note:** HTTP/HTTPS remotes support only download operations.
50 changes: 23 additions & 27 deletions static/docs/user-guide/remotes/oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,33 +45,6 @@ oss_key_id = my-key-id
oss_key_secret = my-key-secret
```

<details>

### Details: Aliyun OSS available options

- `oss_key_id` - OSS key id to use to access a remote.

```dvc
$ dvc remote modify --local \
myremote oss_key_id my-key-id
```

- `oss_key_secret` - OSS secret key for authorizing access into a remote.

```dvc
$ dvc remote modify --local \
myremote oss_key_secret my-key-secret
```

- `oss_endpoint` - OSS endpoint values for accessing remote container.

```dvc
$ dvc remote modify \
myremote oss_endpoint endpoint
```

</details>

You can also use the environment variables to set the options:

```dvc
Expand Down Expand Up @@ -107,3 +80,26 @@ $ export OSS_ACCESS_KEY_SECRET='AccessKeySecret'
> access to public read bucket and public bucket.
</details>

### Aliyun OSS available options

- `oss_key_id` - OSS key id to use to access a remote.

```dvc
$ dvc remote modify --local \
myremote oss_key_id my-key-id
```

- `oss_key_secret` - OSS secret key for authorizing access into a remote.

```dvc
$ dvc remote modify --local \
myremote oss_key_secret my-key-secret
```

- `oss_endpoint` - OSS endpoint values for accessing remote container.

```dvc
$ dvc remote modify \
myremote oss_endpoint endpoint
```
6 changes: 1 addition & 5 deletions static/docs/user-guide/remotes/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ url = ssh://[email protected]/path/to/dir
port = 2222
```

<details>

### Details: All remote options
### All remote options

- `url` - remote location URL.

Expand Down Expand Up @@ -86,8 +84,6 @@ port = 2222
$ dvc remote modify ssh-remote gss_auth true
```

</details>

<details>

### Tip: Keep the password private
Expand Down

0 comments on commit 6ed975b

Please sign in to comment.