From 7bd11d45f97fe87a8da08852835ff5859395620b Mon Sep 17 00:00:00 2001 From: Dmitry Petrov Date: Sun, 24 Nov 2019 09:47:40 -0800 Subject: [PATCH 1/3] Get rid of links to external dependencies --- static/docs/command-reference/import.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/static/docs/command-reference/import.md b/static/docs/command-reference/import.md index 1444626f0f..be25724a3d 100644 --- a/static/docs/command-reference/import.md +++ b/static/docs/command-reference/import.md @@ -1,9 +1,11 @@ # import -Download or copy file or directory from any DVC project in a Git -repository (e.g. hosted on GitHub) into the workspace, and track -changes in this [external dependency](/doc/user-guide/external-dependencies). -Creates [DVC-files](/doc/user-guide/dvc-file-format). +Import file or directory from any DVC project in a Git +repository (e.g. hosted on GitHub). The imported files will be copied +or downloaded into the workspace while DVC keeps information +about the source in a created [DVC-files](/doc/user-guide/dvc-file-format). +Information about the source is a link to a imported repository and it is +used during imported file [update](/doc/user-guide/external-dependencies). > See also `dvc get`, that corresponds to the first step this command performs > (just download the data). @@ -100,9 +102,10 @@ Importing 'data/data.xml (git@github.com:iterative/example-get-started)' In contrast with `dvc get`, this command doesn't just download the data file, but it also creates an import stage -([DVC-file](/doc/user-guide/dvc-file-format)) to register this data as an -[external dependency](/doc/user-guide/external-dependencies) (using the `repo` -field). Check `data.xml.dvc`: +([DVC-file](/doc/user-guide/dvc-file-format)) with a link to this data source. +This DVC-file with the link is used during imported +file [update](/doc/user-guide/external-dependencies). +Check `data.xml.dvc`: ```yaml md5: 7de90e7de7b432ad972095bc1f2ec0f8 From bf04f7144473ba16512d37be7479be395d67bcfc Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 24 Nov 2019 17:23:55 -0600 Subject: [PATCH 2/3] cmd ref: rewrite import intro (without link to external deps doc) per https://github.com/iterative/dvc.org/pull/817#pullrequestreview-321975872 and https://github.com/iterative/dvc.org/pull/817#issuecomment-557912147 --- static/docs/command-reference/import.md | 27 +++++++++++-------------- static/docs/get-started/initialize.md | 4 ++-- 2 files changed, 14 insertions(+), 17 deletions(-) diff --git a/static/docs/command-reference/import.md b/static/docs/command-reference/import.md index be25724a3d..9034e1b034 100644 --- a/static/docs/command-reference/import.md +++ b/static/docs/command-reference/import.md @@ -1,11 +1,10 @@ # import -Import file or directory from any DVC project in a Git -repository (e.g. hosted on GitHub). The imported files will be copied -or downloaded into the workspace while DVC keeps information -about the source in a created [DVC-files](/doc/user-guide/dvc-file-format). -Information about the source is a link to a imported repository and it is -used during imported file [update](/doc/user-guide/external-dependencies). +Download or copy an output file or directory from any DVC +repository (e.g. hosted on GitHub) into the workspace. DVC +creates a [DVC-file](/doc/user-guide/dvc-file-format) with information about the +data source, which can later be used for +[updating](/doc/command-reference/update) the import. > See also `dvc get`, that corresponds to the first step this command performs > (just download the data). @@ -49,12 +48,11 @@ _import stage_ (DVC-file) is then created, extending the full file or directory name of the imported data e.g. `data.txt.dvc` – similar to having used `dvc run` to generate the same output. -DVC supports DVC-files that refer to data in an external DVC repository (hosted -on a Git server) a.k.a _import stages_. In such a DVC-file, the `deps` section -specifies the `repo` URL and data `path`, and the `outs` section contains the -corresponding local path in the workspace. It records enough data from the -imported data to enable DVC to efficiently check it to determine whether the -local copy is out of date. +DVC-files support references to data in an external DVC repository (hosted on a +Git server). In such a DVC-file, the `deps` section specifies the `repo`-`url` +and data `path` fields, and the `outs` section contains the corresponding local +workspace `path` field. This is enough data about the imported data, to enable +DVC efficiently determining whether the local copy is out of date. To actually [track the data](https://dvc.org/doc/get-started/add-files), `git add` (and `git commit`) the import stage. @@ -103,9 +101,8 @@ Importing 'data/data.xml (git@github.com:iterative/example-get-started)' In contrast with `dvc get`, this command doesn't just download the data file, but it also creates an import stage ([DVC-file](/doc/user-guide/dvc-file-format)) with a link to this data source. -This DVC-file with the link is used during imported -file [update](/doc/user-guide/external-dependencies). -Check `data.xml.dvc`: +This DVC-file with the link is used during imported file +[update](/doc/user-guide/external-dependencies). Check `data.xml.dvc`: ```yaml md5: 7de90e7de7b432ad972095bc1f2ec0f8 diff --git a/static/docs/get-started/initialize.md b/static/docs/get-started/initialize.md index 1fbc6d85fe..61b5360b1f 100644 --- a/static/docs/get-started/initialize.md +++ b/static/docs/get-started/initialize.md @@ -1,8 +1,8 @@ # Initialize There are a few recommended ways to install DVC: OS-specific package/installer, -`pip`, `conda`, and Homebrew. See the [**Installation**](/doc/install) page for -all the options and details. +`pip`, `conda`, and Homebrew. See [Installation](/doc/install) for all the +options and details. Let's start by creating a workspace we can version with Git. Then run `dvc init` inside to create the DVC project: From ec4525a1c625c02cf2c8d2976454d0681560d7d9 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 24 Nov 2019 17:36:59 -0600 Subject: [PATCH 3/3] cmd ref: reword paragraph in example and fix links per https://github.com/iterative/dvc.org/pull/817#issuecomment-557912147 and https://github.com/iterative/dvc.org/pull/817#pullrequestreview-321976006 --- static/docs/command-reference/import.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/static/docs/command-reference/import.md b/static/docs/command-reference/import.md index 9034e1b034..c7260ccc40 100644 --- a/static/docs/command-reference/import.md +++ b/static/docs/command-reference/import.md @@ -3,8 +3,8 @@ Download or copy an output file or directory from any DVC repository (e.g. hosted on GitHub) into the workspace. DVC creates a [DVC-file](/doc/user-guide/dvc-file-format) with information about the -data source, which can later be used for -[updating](/doc/command-reference/update) the import. +data source, which can later be used to [update](/doc/command-reference/update) +the import. > See also `dvc get`, that corresponds to the first step this command performs > (just download the data). @@ -100,9 +100,9 @@ Importing 'data/data.xml (git@github.com:iterative/example-get-started)' In contrast with `dvc get`, this command doesn't just download the data file, but it also creates an import stage -([DVC-file](/doc/user-guide/dvc-file-format)) with a link to this data source. -This DVC-file with the link is used during imported file -[update](/doc/user-guide/external-dependencies). Check `data.xml.dvc`: +([DVC-file](/doc/user-guide/dvc-file-format)) with a link to the data source (as +explained in the description above). (This import stage can later be used to +[update](/doc/command-reference/update) the import.) Check `data.xml.dvc`: ```yaml md5: 7de90e7de7b432ad972095bc1f2ec0f8