Skip to content

Commit

Permalink
Merge pull request #2120 from iterative/2.0/pipelines
Browse files Browse the repository at this point in the history
link/term: .dvc/ (dir) & "internal"
  • Loading branch information
jorgeorpinel authored Jan 30, 2021
2 parents ab86409 + a52c940 commit bb68104
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 27 deletions.
6 changes: 3 additions & 3 deletions content/docs/command-reference/destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ $ ls -a
.git code.py foo
```

`dvc destroy` command removed `foo.dvc` and the internal `.dvc/` directory from
the <abbr>workspace</abbr>. But the cache files that are present in the
`/mnt/cache` directory still persist:
`dvc destroy` command removed `foo.dvc` and the `.dvc/` directory from the
<abbr>workspace</abbr>. But the cache files that are present in the `/mnt/cache`
directory still persist:

```dvc
$ tree /mnt/cache
Expand Down
9 changes: 4 additions & 5 deletions content/docs/command-reference/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ DVC works best in a Git repository. This enables all features, providing the
most value. For this reason, `dvc init` (without flags) expects to run in a Git
repository root (a `.git/` directory should be present).

At DVC initialization, a new `.dvc/` directory is created for internal
configuration and <abbr>cache</abbr>
[files and directories](/doc/user-guide/project-structure/internal-files), that
are hidden from the user. This directory is automatically staged with `git add`,
so it can be easily committed with Git.
At DVC initialization, a new `.dvc/` directory is created for configuration,
default <abbr>cache</abbr> location, and other internal files and directories,
that are hidden from the user. This directory is automatically staged with
`git add`, so it can be easily committed with Git.

The command [options](#options) can be used to start an alternative workflow for
advanced scenarios:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/plots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ header (first row) are equivalent to field names.
### DVC template anchors

- `<DVC_METRIC_DATA>` (**required**) - the plot data from any type of metrics
files is converted to a single JSON array internally, and injected instead of
this anchor. Two additional fields will be added: `index` and `rev` (explained
files is converted to a single JSON array, and injected instead of this
anchor. Two additional fields will be added: `index` and `rev` (explained
above).

- `<DVC_METRIC_TITLE>` (optional) - a title for the plot, that can be defined
Expand Down
4 changes: 2 additions & 2 deletions content/docs/start/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ $ git init
$ dvc init
```

A few [directories and files](/doc/user-guide/project-structure/internal-files)
are created that should be added to Git:
A few [internal files](/doc/user-guide/project-structure/internal-files) are
created that should be added to Git:

```dvc
$ git status
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ $ pip install -r requirements.txt
The repository you cloned is already DVC-initialized. It already contains a
`.dvc/` directory with the `config` and `.gitignore` files. These and other
files and directories are hidden from user, as typically there's no need to
interact with them directly. See
[DVC Internals](/doc/user-guide/project-structure/internal-files) to learn more.
interact with them directly.

</details>

Expand Down Expand Up @@ -164,7 +163,7 @@ $ git tag -a "v1.0" -m "model v1.0, 1000 images"

<details>

### Expand to learn more about DVC internals
### Expand to learn more about how DVC works

As we mentioned briefly, DVC does not commit the `data/` directory and
`model.h5` file with Git. Instead, `dvc add` stores them in the
Expand Down
6 changes: 2 additions & 4 deletions content/docs/user-guide/basic-concepts/dvc-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,5 @@ match:
---

Initialized by running `dvc init` in the **workspace** (typically a Git
repository). It will contain the
[`.dvc/` directory](/doc/user-guide/project-structure/internal-files), as well
as `dvc.yaml` and `.dvc` files created with commands such as `dvc add` or
`dvc run`.
repository). It will contain the `.dvc/` directory, as well as `dvc.yaml` and
`.dvc` files created with commands such as `dvc add` or `dvc run`.
3 changes: 1 addition & 2 deletions content/docs/user-guide/project-structure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ as you use DVC and work on your data science experiments.
- `.dvcignore` files (optional) contain a list of paths for DVC to ignore, which
can dramatically increase its operational performance.

- Internal files and directories in
[`.dvc/`](/doc/user-guide/project-structure/internal-files) contains the local
- Internal files and directories in `.dvc/` contains the local
[configuration](/doc/command-reference/config) file(s), default local cache
location, and other utilities that DVC needs to operate.

Expand Down
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.yaml` and `.dvc` files.
⚠️ Not to be confused with `.dvc` files.

- `.dvc/config`: This is a configuration file. The config file can be edited by
hand or with the `dvc config` command.
Expand Down
14 changes: 9 additions & 5 deletions content/linked-terms.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
module.exports = [
{
matches: '.dvc',
url: '/doc/user-guide/project-structure/dvc-files'
},
{
matches: 'dvc.yaml',
url: '/doc/user-guide/project-structure/pipelines-files'
},
{
matches: 'dvc.lock',
url: '/doc/user-guide/project-structure/pipelines-files#dvclock-file'
url: '/doc/user-guide/creating-pipelines#dvclock-file'
},
{
matches: '.dvc',
url: '/doc/user-guide/project-structure/dvc-files'
},
{
matches: '.dvc/',
url: '/doc/user-guide/project-structure/internal-files'
}
]

0 comments on commit bb68104

Please sign in to comment.