Skip to content

Commit

Permalink
Re-add abbrs within details (#1359)
Browse files Browse the repository at this point in the history
* cmd ref: update WebDAV remote info
per #1187 (comment)

* cmd ref: remove WebDAV remote info
for #1355

* glossary: add back DVC project
per #1334 (review)

* Re-add abbrs within details

This feature broke at some point in the past and all these were removed. The
feature has since been fixed, so these are safe to re-add.

* Re-add cache directory in add-files

* Change "cache directory" to "cache"

We don't have a tooltip match for "cache directory"

* Re-add some missed abbrs

* Revert grammar change

I think I missed the correct context originally when editing it, and committed
it because it looked like any other abbr addition.

Co-authored-by: Jorge Orpinel <jorge@orpinel.com>
rogermparent and jorgeorpinel authored May 26, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 0000b67 commit ca302ec
Showing 9 changed files with 47 additions and 26 deletions.
2 changes: 1 addition & 1 deletion content/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
@@ -146,7 +146,7 @@ $ git checkout 2-remote
$ mkdir data
```

You should now have a blank workspace, just before the
You should now have a blank <abbr>workspace</abbr>, just before the
[Add Files](/doc/tutorials/get-started/add-files) chapter.

</details>
7 changes: 4 additions & 3 deletions content/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
@@ -355,9 +355,10 @@ $ dvc remote add myremote https://example.com/path/to/dir
A "local remote" is a directory in the machine's file system.

> While the term may seem contradictory, it doesn't have to be. The "local" part
> refers to the machine where the project is stored, so it can be any directory
> accessible to the same system. The "remote" part refers specifically to the
> project/repository itself. Read "local, but external" storage.
> refers to the machine where the <abbr>project</abbr> is stored, so it can be
> any directory accessible to the same system. The "remote" part refers
> specifically to the project/repository itself. Read "local, but external"
> storage.
Using an absolute path (recommended):

6 changes: 3 additions & 3 deletions content/docs/command-reference/remote/index.md
Original file line number Diff line number Diff line change
@@ -76,9 +76,9 @@ For the typical process to share the <abbr>project</abbr> via remote, see
### What is a "local remote" ?

While the term may seem contradictory, it doesn't have to be. The "local" part
refers to the machine where the project is stored, so it can be any directory
accessible to the same system. The "remote" part refers specifically to the
project/repository itself. Read "local, but external" storage.
refers to the machine where the <abbr>project</abbr> is stored, so it can be any
directory accessible to the same system. The "remote" part refers specifically
to the project/repository itself. Read "local, but external" storage.

</details>

6 changes: 3 additions & 3 deletions content/docs/command-reference/remote/list.md
Original file line number Diff line number Diff line change
@@ -46,9 +46,9 @@ Let's for simplicity add a _default_ local remote:
### What is a "local remote" ?

While the term may seem contradictory, it doesn't have to be. The "local" part
refers to the machine where the project is stored, so it can be any directory
accessible to the same system. The "remote" part refers specifically to the
project/repository itself. Read "local, but external" storage.
refers to the machine where the <abbr>project</abbr> is stored, so it can be any
directory accessible to the same system. The "remote" part refers specifically
to the project/repository itself. Read "local, but external" storage.

</details>

2 changes: 1 addition & 1 deletion content/docs/tutorials/get-started/add-files.md
Original file line number Diff line number Diff line change
@@ -40,7 +40,7 @@ Committing DVC-files with Git allows us to track different versions of the

### Expand to learn about DVC internals

`dvc add` moves the actual data file to the cache directory (see
`dvc add` moves the actual data file to the <abbr>cache</abbr> directory (see
[DVC Files and Directories](/doc/user-guide/dvc-files-and-directories)), while
the entries in the workspace may be file links to the actual files in the DVC
cache.
6 changes: 3 additions & 3 deletions content/docs/tutorials/get-started/configure.md
Original file line number Diff line number Diff line change
@@ -16,9 +16,9 @@ For simplicity, let's setup a local remote:
### What is a "local remote" ?

While the term may seem contradictory, it doesn't have to be. The "local" part
refers to the machine where the project is stored, so it can be any directory
accessible to the same system. The "remote" part refers specifically to the
project/repository itself. Read "local, but external" storage.
refers to the machine where the <abbr>project</abbr> is stored, so it can be any
directory accessible to the same system. The "remote" part refers specifically
to the project/repository itself. Read "local, but external" storage.

</details>

14 changes: 7 additions & 7 deletions content/docs/tutorials/pipelines.md
Original file line number Diff line number Diff line change
@@ -104,7 +104,7 @@ When we run `dvc add` `Posts.xml.zip`, DVC creates a

At DVC initialization, a new `.dvc/` directory is created for internal
configuration and <abbr>cache</abbr>
[files and directories](/doc/user-guide/dvc-files-and-directories), that are
[files and directories](/doc/user-guide/dvc-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.

@@ -126,9 +126,9 @@ This file can be committed with Git instead of the data file itself.
The data file `Posts.xml.zip` is linked (or copied) from
`.dvc/cache/ce/68b98d82545628782c66192c96f2d2`, and added to `.gitignore`. Even
if you remove it from the workspace, or `git checkout` a different commit, the
data is not lost if a corresponding DVC-file is committed. It's enough to run
`dvc checkout` or `dvc pull` to restore data files.
if you remove it from the <abbr>workspace</abbr>, or `git checkout` a different
commit, the data is not lost if a corresponding DVC-file is committed. It's
enough to run `dvc checkout` or `dvc pull` to restore data files.

</details>

@@ -183,10 +183,10 @@ outs:
```

Just like the DVC-file we created earlier with `dvc add`, this stage file uses
`md5` hashes (that point to the cache) to describe and version control
dependencies and outputs. Output `data/Posts.xml` file is saved as
`md5` hashes (that point to the <abbr>cache</abbr>) to describe and version
control dependencies and outputs. Output `data/Posts.xml` file is saved as
`.dvc/cache/a3/04afb96060aad90176268345e10355` and linked (or copied) to the
workspace, as well as added to `.gitignore`.
<abbr>workspace</abbr>, as well as added to `.gitignore`.

Two things are worth noticing here. First, by analyzing dependencies and outputs
that DVC-files describe, we can restore the full series of commands (pipeline
10 changes: 5 additions & 5 deletions content/docs/tutorials/versioning.md
Original file line number Diff line number Diff line change
@@ -163,9 +163,9 @@ $ git tag -a "v1.0" -m "model v1.0, 1000 images"
### Expand to learn more about DVC internals

As we mentioned briefly, DVC does not commit the `data/` directory and
`model.h5` file with Git. Instead, `dvc add` stores them in the cache (usually
in `.dvc/cache`) and adds them to `.gitignore`. We then `git commit` DVC-files
that contain file hashes that point to cached data.
`model.h5` file with Git. Instead, `dvc add` stores them in the
<abbr>cache</abbr> (usually in `.dvc/cache`) and adds them to `.gitignore`. We
then `git commit` DVC-files that contain file hashes that point to cached data.

In this case we created `data.dvc` and `model.h5.dvc`. Refer to
[DVC-File Format](/doc/user-guide/dvc-file-format) to learn more about how these
@@ -281,8 +281,8 @@ the `v2.0` tag.
### Expand to learn more about DVC internals

As we have learned already, DVC keeps data files out of Git (by adjusting
`.gitignore`) and puts them into the cache (usually it's a `.dvc/cache`
directory inside the repository). Instead, DVC creates
`.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-file-format). These text files serve as data
placeholders that point to the cached files, and they can be easily version
controlled with Git.
20 changes: 20 additions & 0 deletions content/docs/user-guide/basic-concepts/dvc-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 'DVC Project'
match:
[
'DVC project',
'DVC projects',
project,
projects,
'DVC repository',
'DVC repositories',
repository,
repositories,
]
---

Initialized by running `dvc init` in the **workspace** (typically in a Git
repository). It will contain the
[`.dvc/` directory](/doc/user-guide/dvc-files-and-directories) and
[DVC-files](/doc/user-guide/dvc-file-format) created with commands such as
`dvc add` or `dvc run`.

0 comments on commit ca302ec

Please sign in to comment.