-
Notifications
You must be signed in to change notification settings - Fork 394
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 functionality to link arbitrary strings in code blocks #1576
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
99ce15c
Add functionality to link arbitrary strings in code blocks
rogermparent 4339fdd
Move new linked term definitions to an external config file
rogermparent d70cdd5
Replace explicit `dvc.yaml` links with auto-replaced instances
rogermparent 0bd435f
Add entries for .dvc and dvc.lock
rogermparent b041280
Replace explicit `.dvc` links with auto-links
rogermparent 66eb353
Replace explicit `dvc.lock` links
rogermparent b1f7b43
Update content/docs/command-reference/move.md
jorgeorpinel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
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
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
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
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
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,10 +1,9 @@ | ||
# import | ||
|
||
Download a file or directory tracked by DVC or by Git into the | ||
<abbr>workspace</abbr>. It also creates a | ||
[`.dvc` file](/doc/user-guide/dvc-files-and-directories#dvc-files) with | ||
information about the data source, which can later be used to | ||
[update](/doc/command-reference/update) the import. | ||
<abbr>workspace</abbr>. It also creates a `.dvc` file with information about the | ||
data source, which can later be used to [update](/doc/command-reference/update) | ||
the import. | ||
|
||
> See also our `dvc.api.open()` Python API function. | ||
|
||
|
@@ -43,9 +42,7 @@ downloading, DVC will try to copy the target data from its <abbr>cache</abbr>). | |
The `path` argument is used to specify the location of the target to be | ||
downloaded within the source repository at `url`. `path` can specify any file or | ||
directory in the source repo, including those tracked by DVC, or by Git. Note | ||
that DVC-tracked targets should be found in a | ||
[`dvc.yaml`](/doc/user-guide/dvc-files-and-directories#dvcyaml-file) or | ||
[`.dvc`](/doc/user-guide/dvc-files-and-directories#dvc-files) file of the | ||
that DVC-tracked targets should be found in a `dvc.yaml` or `.dvc` file of the | ||
project. | ||
|
||
⚠️ The project should have a default | ||
|
@@ -114,11 +111,9 @@ 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-files-and-directories#dvc-files)) 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`: | ||
but it also creates an import stage (`.dvc` file) 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 | ||
|
@@ -155,9 +150,8 @@ Importing | |
-> 'cats-dogs' | ||
``` | ||
|
||
When using this option, the import stage | ||
([`.dvc` file](/doc/user-guide/dvc-files-and-directories#dvc-files)) will also | ||
have a `rev` subfield under `repo`: | ||
When using this option, the import stage (`.dvc` file) will also have a `rev` | ||
subfield under `repo`: | ||
|
||
```yaml | ||
deps: | ||
|
@@ -187,10 +181,9 @@ $ dvc update --rev cats-dogs-v2 | |
If you take a look at our | ||
[dataset registry](https://github.com/iterative/dataset-registry) | ||
<abbr>project</abbr>, you'll see that it's organized into different directories | ||
such as `tutorial/ver` and `use-cases/`, and these contain | ||
[`.dvc` files](/doc/user-guide/dvc-files-and-directories#dvc-files) that track | ||
different datasets. Given this simple structure, its data files can be easily | ||
shared among several other projects using `dvc get` and `dvc import`. For | ||
such as `tutorial/ver` and `use-cases/`, and these contain `.dvc` files that | ||
track different datasets. Given this simple structure, its data files can be | ||
easily shared among several other projects using `dvc get` and `dvc import`. For | ||
example: | ||
|
||
```dvc | ||
|
@@ -245,9 +238,8 @@ Importing ... | |
|
||
> Note that Git-tracked files can be imported from DVC repos as well. | ||
|
||
The file is imported, and along with it, an import stage | ||
([`.dvc` file](/doc/user-guide/dvc-files-and-directories#dvc-files)) is created. | ||
Check `it-standards.csv.dvc`: | ||
The file is imported, and along with it, an import stage (`.dvc` file) is | ||
created. Check `it-standards.csv.dvc`: | ||
|
||
```yaml | ||
deps: | ||
|
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
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note for self: replace all these "import stage" term instances in a separate PR.