Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Basic Concepts + Introduction files #296

Closed
wants to merge 6 commits into from
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
35 changes: 35 additions & 0 deletions static/docs/user-guide/basic-concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Basic Concepts

The DVC user guide constitutes DVC files and directories, DVC file format,
external dependencies, external outputs, update a tracked file, anonymized usage
analytics which are part of basic. Customizations has DVC autocomplete, plugins,
developement version and contributing guide.

Let's understand the basic concepts as you use dvc.

## Workspace

Work space is the current work directory.

## Cache

DVC cache is a hidden (by default it's located in the `.dvc/cache` directory)
storage. For files that are under DVC control it keeps them and their different
versions. You can find more information on cache as described in this
[doc](https://dvc.org/doc/commands-reference/config#cache).

## Remote

In DVC you can have remote data storage or a remote git hosted code server.
A remote can be specified by the remote type prefix and a path. You can find
more information on DVC remote in this
[doc](https://dvc.org/doc/commands-reference/config#remote).

## DVC file

When you add a file or a stage to your pipeline, DVC creates a special `.dvc`
file that contains all the needed information to track your data. The file
itself is in a simple YAML format and could be easily written or altered
(after being created by `dvc run` or `dvc add`) by hand. You can find more
information present in
[this](https://dvc.org/doc/user-guide/dvc-files-and-directories#dvc-files-and-directories) doc.
14 changes: 6 additions & 8 deletions static/docs/user-guide/contributing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,12 @@ on the default port `3000`.

## Code style guidelines

- **Markdown and JS files:** no trailing whitespaces are allowed.

- **Markdown and JS files:** content must be properly formatted at 80 symbols
width. We recommend using Visual Studio Code and the
[Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)
plugin to format the content of Markdown files or install the pre-commit hook
described above.

- No trailing whitespaces are allowed. Both for JS and Mardown files.
- Content in the raw file (`file-name.md`) should be less than 80 symbols width.
We recommend using Visual Studio Code and the
[Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)
plugin to format the content of Mardown files or install the pre-commit hook
described above.
- **Markdown:** we use `prettier` default conventions to format our files. It's
highly recommended to install the hook or run `prettier` manually before
submitting the pull request.
Expand Down
15 changes: 15 additions & 0 deletions static/docs/user-guide/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Introduction

The DVC user guide constitutes DVC files and directories, DVC file format,
external dependencies, external outputs, update a tracked file, anonymized usage
analytics which are part of basic. Customizations has DVC autocomplete, plugins,
developement version and contributing guide.

tapaswenipathak marked this conversation as resolved.
Show resolved Hide resolved
Let's understand the relation between basic concepts as you use DVC.

Workspace acts as a current work directory. You would setup the remote using the
dvc config command by setting the type and prefix. Remote setting can be used
for setting the remote data storage or remote code server. This is the basic
requirement for running dvc as a project. DVC has a hidden cache which is
located in `.dvc/cache` directory. For files that are under DVC control it keeps
them and their different versions.