Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ code.
Make sure you have the latest LTS version of [Node.js](https://nodejs.org) and
[Yarn](https://yarnpkg.com) installed.

Run `yarn command`.
Run `yarn`.

## Commands

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/cache/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ positional arguments:

## Description

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

The cache is where your data files, models, etc. (anything you want to version
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ advanced scenarios:
- [Initializing DVC without Git](#how-does-it-affect-dvc-commands) - support for
SCM other than Git, deployment automation cases, etc.

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

### Initializing DVC in subdirectories
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/remote/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,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 location of the storage relative to the project, so it can be any
directory in the file system. "Remote" is the term that refers to the storage.
Read "local cache backup".

</details>

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/remote/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,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 location of the storage relative to the project, so it can be any
directory in the file system. "Remote" is the term that refers to the storage.
Read "local cache backup".

</details>

Expand Down
25 changes: 22 additions & 3 deletions content/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# DVC Documentation

Welcome! In here you may find all the guiding material and technical documents
needed to learn about DVC: how to use it, how it works, and where to go for
additional resources.
Welcome! In here you may find all the material and technical details needed to
learn about DVC: how to use it, how it works, and where to go for additional
resources.

## What is DVC?

Data Version Control, or DVC, is **a new type of experiment management
software** built on top of the existing engineering toolset that you're already
used to, particularly [Git](https://git-scm.com) source code management. DVC
reduces the gap between existing tools and data science needs.

If you store and process data files or datasets to produce other data or machine
learning models, and you want to

- capture and save <abbr>data artifacts</abbr> the same way you capture code;
- track and switch between different versions of data or models easily;
- understand how data or models were built in the first place;
- be able to compare models and metrics to each other;
- bring software engineering best practices to your data science team;
- among other [use cases](/doc/use-cases)

DVC is for you!

## Before you start

Expand Down
29 changes: 6 additions & 23 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[
{
"slug": "home",
"slug": "",
"label": "Home",
"source": "index.md"
},
{
Expand Down Expand Up @@ -30,32 +31,14 @@
"children": [
{
"slug": "get-started",
"source": false,
"source": "get-started/index.md",
"tutorials": {
"katacoda": "https://katacoda.com/dvc/courses/get-started/initialize"
},
"children": [
"agenda",
"initialize",
"configure",
"add-files",
"store-data",
"retrieve-data",
"import-data",
{
"label": "Connect with Code",
"slug": "connect-code-and-data"
},
"pipeline",
"visualize",
"reproduce",
"metrics",
"experiments",
"compare-experiments",
{
"label": "Get Older Files",
"slug": "older-versions"
}
"versioning-basics",
"data-pipelines",
"experiment-management"
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions content/docs/tutorials/deep/preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ $ pip install -r code/requirements.txt
DVC works on top of Git repositories. You run DVC initialization in a repository
directory to create DVC meta files and directories.

At DVC initialization, a new `.dvc/` directory will be created for internal
configuration and cache
[files and directories](/doc/user-guide/dvc-files-and-directories) that are
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
hidden from the user. We describe some DVC internals below for a better
understanding of how it works.

Expand Down
89 changes: 0 additions & 89 deletions content/docs/tutorials/get-started/add-files.md

This file was deleted.

39 changes: 0 additions & 39 deletions content/docs/tutorials/get-started/agenda.md

This file was deleted.

42 changes: 0 additions & 42 deletions content/docs/tutorials/get-started/compare-experiments.md

This file was deleted.

67 changes: 0 additions & 67 deletions content/docs/tutorials/get-started/configure.md

This file was deleted.

Loading