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.

Sign up for GitHub

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

Jump to bottom

Get rid of links to external dependencies in import command #817

Merged
merged 3 commits into from
Nov 26, 2019
Merged

Get rid of links to external dependencies in import command #817

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7bd11d4
Get rid of links to external dependencies
dmpetrov Nov 24, 2019
bf04f71
cmd ref: rewrite import intro (without link to external deps doc)
jorgeorpinel Nov 24, 2019
ec4525a
cmd ref: reword paragraph in example
jorgeorpinel Nov 24, 2019
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
17 changes: 10 additions & 7 deletions static/docs/command-reference/import.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# import

Download or copy file or directory from any <abbr>DVC project</abbr> in a Git
repository (e.g. hosted on GitHub) into the <abbr>workspace</abbr>, 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 <abbr>DVC project</abbr> in a Git
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
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
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
used during imported file [update](/doc/user-guide/external-dependencies).
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

> See also `dvc get`, that corresponds to the first step this command performs
> (just download the data).
Expand Down Expand Up @@ -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).
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
Check `data.xml.dvc`:

```yaml
md5: 7de90e7de7b432ad972095bc1f2ec0f8
Expand Down