Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guide: update links from old "DVC Files" #2117

Merged
merged 6 commits into from
Jan 27, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions content/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ positional arguments:
## Description

This command is usually needed after `git checkout`, `git clone`, or any other
operation that changes the current [DVC files](/doc/user-guide/dvc-files). It
restores the corresponding versions of the DVC-tracked files and directories
from the <abbr>cache</abbr> to the workspace.
operation that changes the current
[DVC files](/doc/user-guide/project-structure). It restores the corresponding
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
versions of the DVC-tracked files and directories from the <abbr>cache</abbr> to
the workspace.

The `targets` given to this command (if any) limit what to checkout. It accepts
paths to tracked files or directories (including paths inside tracked
Expand Down Expand Up @@ -85,9 +86,10 @@ the pipeline must be reproduced (using `dvc repro`) to regenerate its outputs.
files referenced in later stages than the `targets`.

- `-f`, `--force` - does not prompt when removing workspace files. Changing the
current set of [DVC files](/doc/user-guide/dvc-files) with `git checkout` can
result in the need for DVC to remove files that don't match those references
or are missing from cache. (They are not "committed", in DVC terms.)
current [set of DVC files](/doc/user-guide/project-structure) with
`git checkout` can result in the need for DVC to remove files that don't match
those references or are missing from cache. (They are not "committed", in DVC
terms.)

- `--relink` - ensures the file linking strategy (`reflink`, `hardlink`,
`symlink`, or `copy`) for all data in the workspace is consistent with the
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ This is the main section with the general config options:
(default) and `false`.

- `core.autostage` - if enabled, DVC will automatically stage (`git add`)
[DVC files](/doc/user-guide/dvc-files) created or modified by DVC commands
(`dvc add`, `dvc run`, etc.). The files will not be committed. Accepts values
`true` and `false` (default).
[DVC files](/doc/user-guide/project-structure) created or modified by commands
like `dvc add`, `dvc run`, etc. The files will not be committed. Accepts
values `true` and `false` (default).

### remote

Expand Down
7 changes: 3 additions & 4 deletions content/docs/command-reference/destroy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# destroy

Remove all [DVC files](/doc/user-guide/dvc-files) and
Remove all [DVC files](/doc/user-guide/project-structure) and
[internals](/doc/user-guide/dvc-internals) from a <abbr>DVC project</abbr>.

## Synopsis
Expand All @@ -21,9 +21,8 @@ Note that the <abbr>cache directory</abbr> will be removed as well, unless it's
cache, DVC will replace them with the latest versions of the actual files and
directories first, so that your data is intact after the project's destruction.

> Refer to [DVC files](/doc/user-guide/dvc-files) and
> [internals](/doc/user-guide/dvc-internals) for more details on the directories
> and files deleted by this command.
> Refer to [Project Structure](/doc/user-guide/project-structure) for more
> details on the directories and files deleted by this command.

## Options

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ One of the scope options (`--workspace`, `--all-branches`, `--all-tags`,
`--all-commits`) or a combination of them must be provided. Each of them
corresponds to keeping the data for the current workspace, and possibly for a
certain set of commits (determined by reading the
[DVC files](/doc/user-guide/dvc-files) in them). See the [Options](#options)
section for more details.
[DVC files](/doc/user-guide/project-structure) in them). See the
[Options](#options) section for more details.

> Note that `dvc gc` tries to fetch any missing
> [`.dir` files](/doc/user-guide/dvc-internals#structure-of-the-cache-directory)
Expand Down Expand Up @@ -119,7 +119,7 @@ $ du -sh .dvc/cache/

When you run `dvc gc --workspace`, DVC removes all objects from cache that are
not referenced in the <abbr>workspace</abbr> (by collecting hash values from the
[DVC files](/doc/user-guide/dvc-files)):
[DVC files](/doc/user-guide/project-structure)):

```dvc
$ dvc gc --workspace
Expand Down
15 changes: 8 additions & 7 deletions content/docs/command-reference/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ etc.) doesn't have DVC initialized (no `.dvc/` directory present).
Namely:

**Checkout**: For any commit hash, branch or tag, `git checkout` retrieves the
[DVC files](/doc/user-guide/dvc-files) corresponding to that version. These
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
files in turn refer to data stored in <abbr>cache</abbr>, but not necessarily in
the <abbr>workspace</abbr>. Normally, it would be necessary to use
`dvc checkout` to update the workspace accordingly.
[DVC files](/doc/user-guide/project-structure) corresponding to that version.
These files in turn refer to data stored in <abbr>cache</abbr>, but not
necessarily in the <abbr>workspace</abbr>. Normally, it would be necessary to
use `dvc checkout` to update the workspace accordingly.

This hook automates `dvc checkout` after `git checkout`.

Expand Down Expand Up @@ -168,9 +168,10 @@ $ dvc pull -aT
## Example: Checkout both Git and DVC

Switching from one Git commit to another (with `git checkout`) may change the
set of [DVC files](/doc/user-guide/dvc-files) in the <abbr>workspace</abbr>.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
This would mean that the currently present data files and directories no longer
matches project's version (which can be fixed with `dvc checkout`).
[set of DVC files](/doc/user-guide/project-structure) in the
<abbr>workspace</abbr>. This would mean that the currently present data files
and directories no longer matches project's version (which can be fixed with
`dvc checkout`).

Let's first list the available tags in the _Get Started_ repo:

Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@ positional arguments:
## Description

A side-effect of DVC is that it hides actual data paths, by effectively
replacing files and directories with [DVC files](/doc/user-guide/dvc-files). So
you don't see data files/dirs when you browse a <abbr>DVC repository</abbr> on
Git hosting (e.g. GitHub), you just see the `dvc.yaml` and `.dvc` files. This
can make it hard to navigate the project, for example to find files or
directories for use with `dvc get`, `dvc import`, or `dvc.api` functions.
replacing files and directories with
[DVC files](/doc/user-guide/project-structure). So you don't see data files/dirs
when you browse a <abbr>DVC repository</abbr> on Git hosting (e.g. GitHub), you
just see the `dvc.yaml` and `.dvc` files. This can make it hard to navigate the
project, for example to find files or directories for use with `dvc get`,
`dvc import`, or `dvc.api` functions.

This command produces a view of a DVC repository, as if files and directories
tracked by DVC were found directly in the Git repo. Its output is equivalent to
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/metrics/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ positional arguments:
## Description

Finds and prints all metrics in the <abbr>project</abbr> by examining all of its
[DVC files](/doc/user-guide/dvc-files).
`dvc.yaml` files (by default).

If `targets` are provided, it will show those specific metrics files instead.
With the `-a` or `-T` options, this command shows the different metrics values
Expand Down
3 changes: 2 additions & 1 deletion content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ The following config options are available for all remote types:
DVC will recalculate the file hashes upon download (e.g. `dvc pull`) to make
sure that these haven't been modified, or corrupted during download. It may
slow down the aforementioned commands. The calculated hash is compared to the
value saved in the corresponding [DVC file](/doc/user-guide/dvc-files).
value saved in the corresponding
[DVC file](/doc/user-guide/project-structure).

> Note that this option is enabled on **Google Drive** remotes by default.

Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ tracked files or directories (including paths inside tracked directories),
`.dvc` files, and stage names (found in `dvc.yaml`).

The `--all-branches`, `--all-tags`, and `--all-commits` options enable comparing
[DVC files](/doc/user-guide/dvc-files) referenced in multiple Git commits at
once.
[DVC files](/doc/user-guide/project-structure) referenced in multiple Git
commits at once.

If no differences are detected, `dvc status` prints
`Data and pipelines are up to date.` or
Expand Down
4 changes: 2 additions & 2 deletions content/docs/install/plugins.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# IDE Plugins and Syntax Highlighting

When files or directories are added to the project, or stages to a pipeline,
[DVC files](/doc/user-guide/dvc-files) are created. These use a simple YAML
format.
[DVC files](/doc/user-guide/project-structure) are created. These use a simple
YAML format.

We maintain a [schema](https://github.com/iterative/dvcyaml-schema) for
`dvc.yaml` that can enable IDE syntax checks and auto-completion.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/use-cases/data-registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ $ git commit -am "Add 1,000 more songs to music/ dataset."

Iterating on this process for several datasets can give shape to a robust
registry. The result is basically a repo that versions a set of
[metafiles](/doc/user-guide/dvc-files). Let's see an example:
[metafiles](/doc/user-guide/project-structure). Let's see an example:
Comment on lines 185 to +186
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW the term "metafile" still exists, here and there.


```dvc
$ tree --filelimit=10
Expand Down
4 changes: 2 additions & 2 deletions content/docs/use-cases/sharing-data-and-model-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ with the `dvc push` command:
$ dvc push
```

Code and [DVC files](/doc/user-guide/dvc-files) can be safely committed and
pushed with Git.
Code and [DVC files](/doc/user-guide/project-structure/pipelines-files) can be
safely committed and pushed with Git.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

## Download code

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ work!
and models for you 💘._

DVC enables data _versioning through codification_. You produce simple
[metafiles](/doc/user-guide/dvc-files) once, describing what datasets, ML
artifacts, etc. to track. This metadata can be put in Git in lieu of large
[metafiles](/doc/user-guide/project-structure) once, describing what datasets,
ML artifacts, etc. to track. This metadata can be put in Git in lieu of large
files. Now you can use DVC to create [snapshots](/doc/command-reference/add) of
the data, [restore](/doc/command-reference/checkout) previous versions,
[reproduce](/doc/command-reference/repro) experiments, record evolving
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -288,13 +288,12 @@ the `v2.0` tag.
As we have learned already, DVC keeps data files out of Git (by adjusting
`.gitignore`) and puts them into the <abbr>cache</abbr> (usually it's a
`.dvc/cache` directory inside the repository). Instead, DVC creates
[DVC files](/doc/user-guide/dvc-files). These text files serve as data
[DVC files](/doc/user-guide/project-structure). These text files serve as data
placeholders that point to the cached files, and they can be easily version
controlled with Git.

When we run `git checkout` we restore pointers (`.dvc` files) first. Then, when
we run `dvc checkout`, we use these pointers to put the right data in the right
place.
When we run `git checkout` we restore these pointers first. Then, when we run
`dvc checkout`, we use these pointers to put the right data in the right place.

</details>

Expand Down
4 changes: 2 additions & 2 deletions content/docs/user-guide/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ is installed when `yarn` runs (see [dev env](#development-environment)).
`dvc`, `yaml`, or `diff` custom languages. `usage` is employed to show the
`dvc --help` output for each command reference. `dvc` can be used to show
examples of commands and their output in a terminal session. `yaml` is used to
show [DVC file](/doc/user-guide/dvc-files) contents, or other YAML data.
`diff` is used mainly for examples of `git diff` output.
show [DVC file](/doc/user-guide/project-structure) contents, or other YAML
data. `diff` is used mainly for examples of `git diff` output.

> Check out the `.md` source code of any command reference to get a better idea,
> for example in
Expand Down
4 changes: 2 additions & 2 deletions content/docs/user-guide/how-to/merge-conflicts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ from multiple team members.'

Sometimes multiple members of a team might work on the the same DVC-tracked
data. And when the time comes to combine their changes, merge conflicts can
happen in Git-tracked [DVC files](/doc/user-guide/dvc-files), which need to be
resolved.
happen in Git-tracked [DVC files](/doc/user-guide/project-structure), which need
to be resolved.

## `dvc.yaml`

Expand Down
8 changes: 4 additions & 4 deletions content/docs/user-guide/project-structure/internal-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Once initialized in a <abbr>project</abbr>, DVC populates its installation
directory (`.dvc/`) with the internal directories and files needed for DVC
operation.

> See also [DVC Files](/doc/user-guide/dvc-files).
> See also `dvc.yaml` and `.dvc` files.

- `.dvc/config`: This is a configuration file. The config file can be edited by
hand or with the `dvc config` command.
Expand All @@ -23,9 +23,9 @@ operation.
`dvc config cache` for related configuration options.

> Note that DVC includes the cache directory in `.gitignore` during
> initialization. No data tracked by DVC will ever be pushed to the Git
> repository, only [DVC files](/doc/user-guide/dvc-files) that are needed to
> download or reproduce them.
> initialization. No data tracked by DVC should ever be pushed to the Git
> repository, only the [DVC files](/doc/user-guide/project-structure) that are
> needed to download or reproduce that data.

- `.dvc/plots`: Directory for
[plot templates](/doc/command-reference/plots#plot-templates)
Expand Down
10 changes: 5 additions & 5 deletions content/docs/user-guide/what-is-dvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ can version experiments, manage large datasets, and make projects reproducible.

- **Data versioning** is enabled by replacing large files, dataset directories,
machine learning models, etc. with small
[metafiles](/doc/user-guide/dvc-files) (easy to handle with Git). These
placeholders point to the original data, which is decoupled from source code
management.
[metafiles](/doc/user-guide/project-structure) (easy to handle with Git).
These placeholders point to the original data, which is decoupled from source
code management.

- **Data storage**: On-premises or cloud storage can be used to store the
project's data separate from its code base. This is how data scientists can
Expand All @@ -52,8 +52,8 @@ can version experiments, manage large datasets, and make projects reproducible.

DVC file such as `dvc.yaml` and `.dvc` files serve as placeholders to track
large data files and directories for versioning (among other
[purposes](/doc/user-guide/dvc-files)). These metafiles change along with your
data, and you can use Git to place them under
[purposes](/doc/user-guide/project-structure)). These metafiles change along
with your data, and you can use Git to place them under
[version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control)
as a proxy to the actual data versions, which are stored in the <abbr>DVC
cache</abbr> (outside of Git). This does not replace features of Git.
Expand Down
4 changes: 1 addition & 3 deletions redirects-list.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,10 @@
"^/doc/tutorials(/.*)? /doc/start",

"^/doc/use-cases/data-and-model-files-versioning/?$ /doc/use-cases/versioning-data-and-model-files",
"^/doc/user-guide/dvc-file-format$ /doc/user-guide/project-structure",
"^/doc/user-guide/dvc-files-and-directories$ /doc/user-guide/project-structure",
"^/doc/user-guide/dvc-files$ /doc/user-guide/project-structure",
"^/doc/user-guide/updating-tracked-files$ /doc/user-guide/how-to/update-tracked-data",
"^/doc/user-guide/how-to/update-tracked-files$ /doc/user-guide/how-to/update-tracked-data",
"^/doc/user-guide/merge-conflicts$ /doc/user-guide/how-to/merge-conflicts",
"^/doc/user-guide/dvc-files$ /doc/user-guide/project-structure",
"^/doc/user-guide/dvc-files/dvc-yaml$ /doc/user-guide/project-structure",
"^/doc/user-guide/dvc-files/advanced-dvc-yaml$ /doc/user-guide/project-structure/pipelines-files",
"^/doc/user-guide/dvc-files/.dvc$ /doc/user-guide/project-structure/dvc-files",
Expand Down