Skip to content

Commit

Permalink
Merge pull request #766 from taylorlee1/update_redirected_links
Browse files Browse the repository at this point in the history
documentation: update some redirected links
  • Loading branch information
jorgeorpinel authored Nov 12, 2019
2 parents 9c781f0 + ab20b19 commit 0375fdb
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion static/docs/command-reference/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/get-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
4 changes: 2 additions & 2 deletions static/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions static/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions static/docs/get-started/add-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion static/docs/get-started/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ $ dvc checkout
DVC is designed to checkout large data files (no matter how large they are) into
your <abbr>workspace</abbr> 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.
2 changes: 1 addition & 1 deletion static/docs/get-started/pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion static/docs/tutorials/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion static/docs/understanding-dvc/related-technologies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<abbr>cache</abbr> to the <abbr>workspace</abbr>, as copying files is a heavy
operation for large files (30 GB+).
Expand Down
2 changes: 1 addition & 1 deletion static/docs/user-guide/large-dataset-optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---
Expand Down
2 changes: 1 addition & 1 deletion static/docs/user-guide/updating-tracked-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Due to the way DVC handles linking between the data files between the
<abbr>cache</abbr> and their counterparts in the <abbr>workspace</abbr> (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
Expand Down

0 comments on commit 0375fdb

Please sign in to comment.