From 8431ddb48d672e92c2994ce77459a32f3e2a2465 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Sat, 11 May 2019 19:16:11 +0530 Subject: [PATCH 1/4] Add introduction --- static/docs/user-guide/introduction.md | 32 ++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 static/docs/user-guide/introduction.md diff --git a/static/docs/user-guide/introduction.md b/static/docs/user-guide/introduction.md new file mode 100644 index 0000000000..e98c9dd4ba --- /dev/null +++ b/static/docs/user-guide/introduction.md @@ -0,0 +1,32 @@ +# 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. From b909caf7039aa9f13be50a4645cef5674d476626 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Sun, 12 May 2019 03:32:27 +0530 Subject: [PATCH 2/4] Add basic-concepts + introduction file and minor review comments --- static/docs/user-guide/basic-concepts.md | 32 +++++++++++++++++++++++ static/docs/user-guide/introduction.md | 33 ++++++------------------ 2 files changed, 40 insertions(+), 25 deletions(-) create mode 100644 static/docs/user-guide/basic-concepts.md diff --git a/static/docs/user-guide/basic-concepts.md b/static/docs/user-guide/basic-concepts.md new file mode 100644 index 0000000000..28e18608ea --- /dev/null +++ b/static/docs/user-guide/basic-concepts.md @@ -0,0 +1,32 @@ +# 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. diff --git a/static/docs/user-guide/introduction.md b/static/docs/user-guide/introduction.md index e98c9dd4ba..2e88f00748 100644 --- a/static/docs/user-guide/introduction.md +++ b/static/docs/user-guide/introduction.md @@ -1,32 +1,15 @@ -# Basic Concepts +# 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. -Let's understand the basic concepts as you use dvc. +Let's understand the relation between 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. +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. From 7bc3eb664f65dbd19dc1896c11c1f95172591254 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 17 May 2019 12:40:45 +0530 Subject: [PATCH 3/4] Line in raw file should be less than 80 symbols --- static/docs/user-guide/basic-concepts.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/static/docs/user-guide/basic-concepts.md b/static/docs/user-guide/basic-concepts.md index 28e18608ea..d3429b5c6d 100644 --- a/static/docs/user-guide/basic-concepts.md +++ b/static/docs/user-guide/basic-concepts.md @@ -15,13 +15,15 @@ Work space is the current work directory. 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). +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). +more information on DVC remote in this +[doc](https://dvc.org/doc/commands-reference/config#remote). ## DVC file @@ -29,4 +31,5 @@ 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. +information present in +[this](https://dvc.org/doc/user-guide/dvc-files-and-directories#dvc-files-and-directories) doc. From 818d7344dac631e5dc4b0b4b98f0e2bfe1de72aa Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 17 May 2019 15:34:13 +0530 Subject: [PATCH 4/4] Unformatted file should have less than 80 symbols per line --- static/docs/user-guide/contributing-documentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/static/docs/user-guide/contributing-documentation.md b/static/docs/user-guide/contributing-documentation.md index 312e096dd2..583801a141 100644 --- a/static/docs/user-guide/contributing-documentation.md +++ b/static/docs/user-guide/contributing-documentation.md @@ -97,8 +97,8 @@ We will review your PR as soon as possible. Thank you for contributing! ## Code style guidelines - No trailing whitespaces are allowed. Both for JS and Mardown files. -- Content must be properly formatted at 80 symbols width. We recommend using - Visual Studio Code and the +- 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.