From 26db8de6833678eb24a2bc3f78435d4041e4ae03 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 27 Apr 2020 14:27:15 -0500 Subject: [PATCH] tutorials: fix deep/prep page format per https://github.com/iterative/dvc.org/pull/1174#pullrequestreview-401183016 --- content/docs/tutorials/deep/preparation.md | 32 +++++++--------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/content/docs/tutorials/deep/preparation.md b/content/docs/tutorials/deep/preparation.md index 85d5800cf9..7a79ab483a 100644 --- a/content/docs/tutorials/deep/preparation.md +++ b/content/docs/tutorials/deep/preparation.md @@ -61,14 +61,15 @@ $ pip install -r code/requirements.txt DVC works best inside Git repositories like the one we're in. Initialize DVC with: -```dvc -$ dvc init -... - At DVC initialization, a new `.dvc/` directory is created for internal configuration and cache [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: +hidden from the user. This directory is automatically staged with `git add`, so +it can be easily committed with Git: + +```dvc +$ dvc init +... $ ls -a .dvc . .. .gitignore config tmp @@ -78,26 +79,13 @@ A .dvc/.gitignore A .dvc/config ?? .gitignore -$ cat .dvc/.gitignore -/config.local -/updater -/state-journal -/state-wal -/state -/lock -/tmp -/updater.lock -/cache - $ git commit -am "init DVC" ``` -The `.dvc/cache` directory is one of the most important parts of any DVC -project. It will contain all the content of data files. (This is -explained in more detail in the next chapter.) Note that the cache -directory is contained in `.dvc/.gitignore`, which means that it won't be -tracked by Git — It's a local-only directory, and you cannot push it to any Git -remote. +The cache directory, one of the most important parts of any +DVC project, will store the content of all data files. (This is +explained in more detail in the next chapter.) Note that it won't be tracked by +Git — It's a local-only directory, and you cannot push it to a Git remote. For more information refer to [DVC Files and Directories](/doc/user-guide/dvc-files-and-directories).