Skip to content

Commit

Permalink
guide: link to remote storage types in link (#4282)
Browse files Browse the repository at this point in the history
* ref: start Remote Reference (config)

* Restyled by prettier (#4265)

Co-authored-by: Restyled.io <[email protected]>

* guide: move Remote Storage ref into Data Mgmt

* start: links to new Remotes guide and

and some typo fixes

* guide: finalize S3 storage page and

and remove repeated content from cmd refs (link to guide)

* guide: link to remote storage types in link

* guide: move "local remotes" to Remotes (index page) and

update admonitions and links

* ref: remove S3 examples

* guide: emphasize that remotes use regular cloud storage config

* Update content/docs/user-guide/data-management/remote-storage/amazon-s3.md

* guide: drop `worktree` cloud versioning from Remotes Config

per #4264 (comment)

* guide: move cloud versioning near the top of Remote Config

per #4264 (review)

---------

Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Dave Berenbaum <[email protected]>
  • Loading branch information
4 people authored Feb 23, 2023
1 parent 9bf61df commit 573ade6
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion content/docs/api-reference/dvcfilesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ DVCFileSystem provides a unified view of all the files/directories in your
repository, be it Git-tracked or DVC-tracked, or untracked (in case of a local
repository). It can reuse the files in DVC <abbr>cache</abbr> and can otherwise
stream from
[supported remote storage](/doc/command-reference/remote/add#supported-storage-types).
[supported remote storage](/doc/user-guide/data-management/remote-storage#supported-storage-types).

```py
>>> from dvc.api import DVCFileSystem
Expand Down
3 changes: 2 additions & 1 deletion content/docs/api-reference/get_url.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ directory in the remote storage.
💡 Having the resource's URL, it should be possible to download it directly with
an appropriate library, such as [`boto3`] or [`paramiko`].

[storage-types]: /doc/command-reference/remote/add#supported-storage-types
[storage-types]:
/doc/user-guide/data-management/remote-storage#supported-storage-types
[structure of cache directory]:
/doc/user-guide/project-structure/internal-files#structure-of-the-cache-directory
[`boto3`]:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/api-reference/open.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ file can be tracked by DVC (as an <abbr>output</abbr>) or by Git.
(using the `with` keyword, as shown in the examples).

This function makes a direct connection to the
[remote storage](/doc/command-reference/remote/add#supported-storage-types), so
the file contents can be streamed. Your code can process the data
[remote storage](/doc/user-guide/data-management/remote-storage#supported-storage-types),
so the file contents can be streamed. Your code can process the data
[buffer](https://docs.python.org/3/c-api/buffer.html) as it's streamed, which
optimizes memory usage.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ r1 ssh://[email protected]/path/to/dvc/remote/storage
```

> DVC supports several
> [remote types](/doc/command-reference/remote/add#supported-storage-types).
> [remote types](/doc/user-guide/data-management/remote-storage#supported-storage-types).
To download DVC-tracked data from a specific DVC remote, use the `--remote`
(`-r`) option of `dvc pull`:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -686,7 +686,7 @@ $ export OSS_ENDPOINT='endpoint'

💡 Using a HDFS cluster as remote storage is also supported via the WebHDFS API.
Read more about by expanding the WebHDFS section in
[`dvc remote add`](/doc/command-reference/remote/add#supported-storage-types).
[`dvc remote add`](/doc/user-guide/data-management/remote-storage#supported-storage-types).

> If any values given to the parameters below contain sensitive user info, add
> them with the `--local` option, so they're written to a Git-ignored config
Expand Down Expand Up @@ -720,7 +720,7 @@ Read more about by expanding the WebHDFS section in

💡 WebHDFS serves as an alternative for using the same remote storage supported
by HDFS. Read more about by expanding the WebHDFS section in
[`dvc remote add`](/doc/command-reference/remote/add#supported-storage-types).
[`dvc remote add`](/doc/user-guide/data-management/remote-storage#supported-storage-types).

> If any values given to the parameters below contain sensitive user info, add
> them with the `--local` option, so they're written to a Git-ignored config
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ usage: dvc version [-h] [-q | -v]
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`DVC version`](#components-of-dvc-version) | Version of DVC, and name of the binary or package manager (`pip`, `conda`, etc.) used to install DVC (along with a Git commit hash in case of a development version) |
| `Platform` | Version of Python in the environment where DVC is initialized, and information about the operating system |
| `Supports` | Types of [remote storage](/doc/command-reference/remote/add#supported-storage-types) supported by the current DVC setup (their required dependencies are installed) |
| `Supports` | Types of [remote storage](/doc/user-guide/data-management/remote-storage#supported-storage-types) supported by the current DVC setup (their required dependencies are installed) |
| `Cache types` | [Types of links](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache) supported (between <abbr>workspace</abbr> and <abbr>cache</abbr>) |
| `Cache directory` | Filesystem type (e.g. ext4, FAT, etc.) and drive on which the <abbr>cache</abbr> directory is mounted |
| `Caches` | Cache [location types](/doc/user-guide/data-management/managing-external-data) configured in the repo (e.g. local, SSH, S3, etc.) |
| `Remotes` | Remote [location types](/doc/command-reference/remote/add#supported-storage-types) configured in the repo (e.g. SSH, S3, Google Drive, etc.) |
| `Remotes` | Remote [location types](/doc/user-guide/data-management/remote-storage#supported-storage-types) configured in the repo (e.g. SSH, S3, Google Drive, etc.) |
| `Workspace directory` | Filesystem type (e.g. ext4, FAT, etc.) and drive on which the <abbr>workspace</abbr> is mounted |
| `Repo` | Shows whether we are in a DVC repo and/or Git repo |

Expand Down

0 comments on commit 573ade6

Please sign in to comment.