-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cmd ref: rewrite import intro (without link to external deps doc)
per #817 (review) and #817 (comment)
- Loading branch information
1 parent
7bd11d4
commit bf04f71
Showing
2 changed files
with
14 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,10 @@ | ||
# import | ||
|
||
Import file or directory from any <abbr>DVC project</abbr> in a Git | ||
repository (e.g. hosted on GitHub). The imported files will be copied | ||
or downloaded into the <abbr>workspace</abbr> 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 <abbr>output</abbr> file or directory from any <abbr>DVC | ||
repository</abbr> (e.g. hosted on GitHub) into the <abbr>workspace</abbr>. 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 ([email protected]: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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters