diff --git a/static/docs/command-reference/add.md b/static/docs/command-reference/add.md index 8175664c3a..36258cbf25 100644 --- a/static/docs/command-reference/add.md +++ b/static/docs/command-reference/add.md @@ -57,7 +57,7 @@ output (`outs` field), and references the cached file using the checksum. See > `dvc run` to learn about regular stage files. By default DVC tries to use reflinks (see -[File link types](/docs/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) +[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) to avoid copying any file contents and to optimize DVC-file operations for large files. DVC also supports other link types for use on file systems without `reflink` support, but they have to be specified manually. Refer to the diff --git a/static/docs/command-reference/checkout.md b/static/docs/command-reference/checkout.md index 265616a3dd..b882bd8672 100644 --- a/static/docs/command-reference/checkout.md +++ b/static/docs/command-reference/checkout.md @@ -50,7 +50,7 @@ The execution of `dvc checkout` does: Note that this command by default tries NOT to copy files between the cache and the workspace, using reflinks instead when supported by the file system. (Refer to -[File link types](/docs/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache).) +[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache).) The next linking strategy default value is `copy` though, so unless other file link types are manually configured in `cache.type` (using `dvc config`), files will be copied. Keep in mind that having file copies doesn't present much of a diff --git a/static/docs/command-reference/config.md b/static/docs/command-reference/config.md index 943cfef446..afb1415cd6 100644 --- a/static/docs/command-reference/config.md +++ b/static/docs/command-reference/config.md @@ -130,7 +130,7 @@ for more details.) > `dvc unprotect` command to modify files safely. There are pros and cons to different link types. Refer to - [File link types](/docs/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) + [File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache) for a full explanation of each one. - `cache.slow_link_warning` - used to turn off the warnings about having a slow diff --git a/static/docs/command-reference/get-url.md b/static/docs/command-reference/get-url.md index bc5256b3ef..91abdecf2d 100644 --- a/static/docs/command-reference/get-url.md +++ b/static/docs/command-reference/get-url.md @@ -96,7 +96,7 @@ $ dvc get-url s3://bucket/path ``` By default DVC expects your AWS CLI is already -[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). +[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). DVC will be using default AWS credentials file to access S3. To override some of these settings, you could the options described in `dvc remote modify`. diff --git a/static/docs/command-reference/remote/add.md b/static/docs/command-reference/remote/add.md index 568a73b0ca..2b893f6e80 100644 --- a/static/docs/command-reference/remote/add.md +++ b/static/docs/command-reference/remote/add.md @@ -134,7 +134,7 @@ $ dvc remote add myremote s3://bucket/path ``` By default DVC expects your AWS CLI is already -[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). +[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). DVC will be using default AWS credentials file to access S3. To override some of these settings, use the options described in `dvc remote modify`. @@ -162,7 +162,7 @@ So, make sure you have the following permissions enabled: ### Click for S3 API compatible storage example To communicate with a remote object storage that supports an S3 compatible API -(e.g. [Minio](https://minio.io/), +(e.g. [Minio](https://min.io/), [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/), [IBM Cloud Object Storage](https://www.ibm.com/cloud/object-storage) etc.) you must explicitly set the `endpointurl` in the configuration: diff --git a/static/docs/command-reference/remote/modify.md b/static/docs/command-reference/remote/modify.md index b84e6f46fb..f1534d286b 100644 --- a/static/docs/command-reference/remote/modify.md +++ b/static/docs/command-reference/remote/modify.md @@ -67,7 +67,7 @@ The following are the types of remote storage (protocols) supported: ### Click for Amazon S3 available options By default DVC expects your AWS CLI is already -[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). +[configured](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). DVC will be using default AWS credentials file to access S3. To override some of these settings, you could use the following options: @@ -135,7 +135,7 @@ these settings, you could use the following options: ### Click for S3 API compatible storage available options To communicate with a remote object storage that supports an S3 compatible API -(e.g. [Minio](https://minio.io/), +(e.g. [Minio](https://min.io/), [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/), [IBM Cloud Object Storage](https://www.ibm.com/cloud/object-storage) etc.) you must explicitly set the `endpointurl` in the configuration: diff --git a/static/docs/get-started/add-files.md b/static/docs/get-started/add-files.md index 3092c0ae69..68c95214cb 100644 --- a/static/docs/get-started/add-files.md +++ b/static/docs/get-started/add-files.md @@ -68,8 +68,8 @@ Hardlinks and symlinks are also available for optimized cache linking but, (unlike reflinks) they carry the risk of accidentally corrupting the cache if tacked data files are modified in the workspace. -See [Large Dataset Optimization](/docs/user-guide/large-dataset-optimization) -and `dvc config cache` for more information. +See [Large Dataset Optimization](/doc/user-guide/large-dataset-optimization) and +`dvc config cache` for more information. > \***copy-on-write links or "reflinks"** are a relatively new way to link files > in UNIX-style file systems. Unlike hardlinks or symlinks, they support diff --git a/static/docs/get-started/experiments.md b/static/docs/get-started/experiments.md index 1f95ab66cc..a8b852610c 100644 --- a/static/docs/get-started/experiments.md +++ b/static/docs/get-started/experiments.md @@ -45,5 +45,5 @@ $ dvc checkout DVC is designed to checkout large data files (no matter how large they are) into your workspace almost instantly on almost all modern operating systems with file links. See -[Large Dataset Optimization](/docs/user-guide/large-dataset-optimization) for +[Large Dataset Optimization](/doc/user-guide/large-dataset-optimization) for more information. diff --git a/static/docs/get-started/pipeline.md b/static/docs/get-started/pipeline.md index 0011f410c0..b8d3da245c 100644 --- a/static/docs/get-started/pipeline.md +++ b/static/docs/get-started/pipeline.md @@ -37,7 +37,7 @@ $ dvc push This example is simplified just to show you a basic pipeline, see a more advanced [example](/doc/tutorials/pipelines) or complete -[tutorial](/doc/tutorial) to create a +[tutorial](/doc/tutorials/deep) to create a [NLP](https://en.wikipedia.org/wiki/Natural_language_processing) pipeline end-to-end. diff --git a/static/docs/tutorials/pipelines.md b/static/docs/tutorials/pipelines.md index 767576d9ae..7d0677016c 100644 --- a/static/docs/tutorials/pipelines.md +++ b/static/docs/tutorials/pipelines.md @@ -5,7 +5,7 @@ Let's explore the natural language processing ([NLP](https://en.wikipedia.org/wiki/Natural_language_processing)) problem of predicting tags for a given StackOverflow question. For example, we want a classifier that can predict posts about the Python language by tagging them -`python`. (This is a short version of the [Tutorial](/doc/tutorial).) +`python`. (This is a short version of the [Tutorial](/doc/tutorials/deep).) In this example, we will focus on building a simple ML [pipeline](/doc/command-reference/pipeline) that takes an archive with diff --git a/static/docs/understanding-dvc/related-technologies.md b/static/docs/understanding-dvc/related-technologies.md index 34a748e277..2dd2cb7c57 100644 --- a/static/docs/understanding-dvc/related-technologies.md +++ b/static/docs/understanding-dvc/related-technologies.md @@ -125,7 +125,7 @@ http://studio.ml/ could be configured to make workflows simpler. - DVC attempts to use reflinks\* and has other - [file linking options](/docs/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache). + [file linking options](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache). This way the `dvc checkout` command does not actually copy data files from cache to the workspace, as copying files is a heavy operation for large files (30 GB+). diff --git a/static/docs/user-guide/large-dataset-optimization.md b/static/docs/user-guide/large-dataset-optimization.md index 23eef21f04..323ac4711e 100644 --- a/static/docs/user-guide/large-dataset-optimization.md +++ b/static/docs/user-guide/large-dataset-optimization.md @@ -117,7 +117,7 @@ $ dvc config cache.protected true Setting `cache.protected` is important with `hardlink` and/or `symlink` cache file link types. Please refer to the -[Update a Tracked File](/docs/user-guide/updating-tracked-files) on how to +[Update a Tracked File](/doc/user-guide/updating-tracked-files) on how to manage tracked files under these cache configurations. --- diff --git a/static/docs/user-guide/updating-tracked-files.md b/static/docs/user-guide/updating-tracked-files.md index 7d8e8e166e..269e4d420e 100644 --- a/static/docs/user-guide/updating-tracked-files.md +++ b/static/docs/user-guide/updating-tracked-files.md @@ -2,7 +2,7 @@ Due to the way DVC handles linking between the data files between the cache and their counterparts in the workspace (refer -to [Large Dataset Optimization](/docs/user-guide/large-dataset-optimization)), +to [Large Dataset Optimization](/doc/user-guide/large-dataset-optimization)), updating tracked files has to be carried out with caution to avoid data corruption when the DVC config option `cache.type` is set to `hardlink` or/and `symlink`. (See `dvc config cache` for more details on setting the cache file