Merge pull request #810 from iterative/update-cache-dir-note

docs: update notes about cache dir

static/docs/command-reference/init.md

@@ -14,11 +14,10 @@ usage: dvc init [-h] [-q | -v] [--no-scm] [-f]
 ## Description
 
 After DVC initialization, a new directory `.dvc/` will be created with the
-`config` and `.gitignore` files, as well as `cache/` directory. These files and
-directories are hidden from users in general, as there's no need to interact
-with them directly. See
-[DVC Files and Directories](/doc/user-guide/dvc-files-and-directories) to learn
-more.
+`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 Files and Directories](/doc/user-guide/dvc-files-and-directories) to
+learn more.
 
 `.dvc/cache` is one of the most important
 [DVC directories](/doc/user-guide/dvc-files-and-directories). It will hold all

static/docs/get-started/add-files.md

@@ -7,7 +7,7 @@ Let's get a dataset example to play with:
 ```dvc
 $ mkdir data
 $ dvc get https://github.com/iterative/dataset-registry \
-        get-started/data.xml -o data/data.xml
+          get-started/data.xml -o data/data.xml
 ```
 
 > `dvc get` can use any <abbr>DVC project</abbr> hosted on a Git repository to

static/docs/get-started/initialize.md

@@ -16,11 +16,10 @@ $ git commit -m "Initialize DVC project"
 ```
 
 After DVC initialization, a new directory `.dvc/` will be created with the
-`config` and `.gitignore` files, as well as `cache/` directory. These files and
-directories are hidden from users in general, as there's no need to interact
-with them directly See
-[DVC Files and Directories](/doc/user-guide/dvc-files-and-directories) to learn
-more.
+`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 Files and Directories](/doc/user-guide/dvc-files-and-directories) to
+learn more.
 
 > See `dvc init` if you want to get more details about the initialization
 > process, and

static/docs/tutorials/deep/preparation.md

@@ -31,7 +31,7 @@ code into it:
 Windows doesn't include the `wget` utility by default, but you can use the
 browser to download `code.zip`. (Right-click
 [this link](https://code.dvc.org/tutorial/nlp/code.zip) and select
-`Save Link As...` (Chrome). Save it into the project directory.
+`Save Link As...` (Chrome). Save it into the <abbr>project</abbr> directory.
 
 </details>
 
@@ -41,7 +41,7 @@ $ cd classify
 $ git init
 $ wget https://code.dvc.org/tutorial/nlp/code.zip
 $ unzip code.zip -d code && rm -f code.zip
-$ git add code/
+$ git add code
 $ git commit -m "download code"
 ```
 
@@ -62,43 +62,44 @@ DVC works on top of Git repositories. You run DVC initialization in a repository
 directory to create DVC meta files and directories.
 
 After DVC initialization, a new directory `.dvc/` will be created with the
-`config` and `.gitignore` files, as well as `cache/` directory. These files and
-directories are hidden from users in general, as there's no need to interact
-with them directly See
-[DVC Files and Directories](/doc/user-guide/dvc-files-and-directories) to learn
-more. However, we describe some DVC internals below for a better understanding
-of how it works.
+`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 Files and Directories](/doc/user-guide/dvc-files-and-directories) to
+learn more. However, we describe some DVC internals below for a better
+understanding of how it works.
 
 ```dvc
 $ dvc init
 ...
 
 $ ls -a .dvc
-./      ../     .gitignore  cache/  config
+.          ..         .gitignore config     tmp
 
 $ git status -s
 A  .dvc/.gitignore
 A  .dvc/config
+?? .gitignore
 
 $ cat .dvc/.gitignore
-/state
-/lock
 /config.local
 /updater
-/updater.lock
 /state-journal
 /state-wal
+/state
+/lock
+/tmp
+/updater.lock
 /cache
 
-$ git commit -m "init DVC"
+$ git commit -am "init DVC"
 ```
 
 The `.dvc/cache` directory is one of the most important parts of any <abbr>DVC
-repositories</abbr>. The directory contains all the content of data files and
-will be described in the next chapter in more detail. Note that the cache
-directory is contained in the `.dvc/.gitignore` file, which means that it's not
-under Git control — this is your local directory and you cannot push it to any
-Git remote.
+repositories</abbr>. It will contain all the content of data files. (This is
+explained in more detail in the next chapter.) Note that the <abbr>cache</abbr>
+directory is contained in `.dvc/.gitignore`, which means that it won't be under
+Git control — It's a local <abbr>project</abbr> directory and you cannot push it
+to any Git remote.
 
 For more information refer to
 [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories).

static/docs/tutorials/pipelines.md

@@ -101,8 +101,8 @@ When we run `dvc add` `Posts.xml.zip`, DVC creates a
 ### Expand to learn about DVC internals
 
 `dvc init` created a new directory `.dvc/`, with the `config` and `.gitignore`
-files, as well as `cache/` directory. These files and directories are hidden
-from users in general, as there's no need to interact with them directly See
+files. These and other files and directories are hidden from user, as typically
+there's no need to interact with them directly. See
 [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories) to learn
 more.
 

static/docs/tutorials/versioning.md

@@ -62,9 +62,9 @@ $ pip install -r requirements.txt
 ### Expand to learn about DVC internals
 
 The repository you cloned is already DVC-initialized. There should be a `.dvc/`
-directory with the `config` and `.gitignore` files, as well as `cache/`
-directory. These files and directories are hidden from users in general, as
-there's no need to interact with them directly. See
+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 Files and Directories](/doc/user-guide/dvc-files-and-directories) to learn
 more.