Skip to content

Commit

Permalink
docs: remove all H4s
Browse files Browse the repository at this point in the history
and other improvements near the changed text
per #914 (review)
  • Loading branch information
jorgeorpinel committed Jan 12, 2020
1 parent 9dcc560 commit 26d9928
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 29 deletions.
42 changes: 15 additions & 27 deletions public/static/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,28 +217,22 @@ $ 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
```

the `id` will be equal to `0AIac4JZqHhKmUk9PDA`.

Use obtained `id` in remote's URL:
For **shared drives**, 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
Expand Down Expand Up @@ -287,19 +281,13 @@ $ export OSS_ACCESS_KEY_SECRET="my-key-secret"
$ export OSS_ENDPOINT="endpoint"
```

#### Test your OSS storage using docker

Start a container running an OSS emulator.
To **test your OSS storage using docker**, 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'
Expand Down
4 changes: 2 additions & 2 deletions public/static/docs/command-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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).
Expand Down

0 comments on commit 26d9928

Please sign in to comment.