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.

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

imports: examples for new import, update cmd refs; et al [WIP] #509

Merged
merged 28 commits into from
Aug 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d7fdc8f
import-url: try and update example; review term "Get Started" through…
jorgeorpinel Jul 30, 2019
7955ebf
status: small bullet list fixes
jorgeorpinel Jul 30, 2019
7b2ed8d
cmd ref: remove a few unnecessary tabs
jorgeorpinel Jul 30, 2019
9de26d4
import: review external-dependencies guide examples and add one for i…
jorgeorpinel Jul 31, 2019
10dd44f
user-guide: remote unnecessary bullet lists in contributing docs
jorgeorpinel Jul 31, 2019
96bf032
term: python -> Python
jorgeorpinel Jul 31, 2019
df059b9
term: fix typos in dvcignore guide and "lets" -> "let's" throughout docs
jorgeorpinel Jul 31, 2019
6dccbdf
cmd ref: min text improvements
jorgeorpinel Jul 31, 2019
5b09907
cmd ref: restore a couple `git add` ines in fenced code block samples
jorgeorpinel Jul 31, 2019
f814d26
import-url: first feedback round in PR #509
jorgeorpinel Jul 31, 2019
52232fb
user-guide: improve expandable header in external-dependencies doc
jorgeorpinel Jul 31, 2019
74abfe8
cmd ref: 2nd feedback round in PR #509
jorgeorpinel Aug 1, 2019
863c5db
import: add basic example, and related updates in other docs
jorgeorpinel Aug 1, 2019
ad6c28d
term: "data set" -> "data sets"; remove accidental example in update …
jorgeorpinel Aug 1, 2019
0ba7e6a
update: add first, simple example
jorgeorpinel Aug 1, 2019
288a9dc
imoprt: change basic example to download data instead of model
jorgeorpinel Aug 1, 2019
88be660
user-guide: update dvc-file-format doc to include special dependencies
jorgeorpinel Aug 2, 2019
202e805
update: clarify text in example
jorgeorpinel Aug 2, 2019
21e09b5
get-started: fixed <details> sections in example-pipeline doc
jorgeorpinel Aug 2, 2019
7a1d82a
user-guide: move up note in contributing for readability
jorgeorpinel Aug 2, 2019
be6d512
lock: update `update` description and related cmd refs.
jorgeorpinel Aug 3, 2019
7035dfb
update: rewrite cmd ref desc with user perspective focus
jorgeorpinel Aug 3, 2019
f3d3447
cmd ref: remove info about `locked: true` field in DVC-file
jorgeorpinel Aug 3, 2019
077064f
glossary: expand on "External Dependency" term
jorgeorpinel Aug 3, 2019
79eb30b
update: change references to import stages being unlockable
jorgeorpinel Aug 4, 2019
fb7ec4f
glossary: add "DVC repositories" to external dependency term desc.
jorgeorpinel Aug 4, 2019
8d91151
lock: remove `dvc lock` mention and clarify special import stage "loc…
jorgeorpinel Aug 5, 2019
ff095ae
import-url: remove buggy line from sample console output
jorgeorpinel Aug 5, 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
13 changes: 11 additions & 2 deletions src/Documentation/glossary.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,17 @@ export default {
name: 'Output',
match: ['output', 'outputs'],
desc:
'A file or a directory that is under DVC control. See `dvc add`,' +
' `dvc run`, `dvc import`, `dvc import-url` commands.'
'A file or a directory that is under DVC control. See `dvc add`, ' +
'`dvc run`, `dvc import`, `dvc import-url` commands.'
},
{
name: 'External Dependency',
match: ['external dependency', 'external dependencies'],
desc:
'A DVC-file dependency with origin in an external source, for ' +
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
'example HTTP, SSH, Amazon S3, Google Cloud Storage remote ' +
'locations, or even other DVC repositories. See ' +
'[External Dependencies](/doc/user-guide/external-dependencies).'
}
]
}
7 changes: 2 additions & 5 deletions static/docs/commands-reference/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ $ file .dvc/cache/d8/acabbfd4ee51c95da5d7628c7ef74b

What if you have not one dog picture, but hundreds of pictures of dogs and cats?
Your goal might be to build an algorithm to identify dogs and cats in pictures,
and this is your training data set:
and this is your training dataset:

```dvc
$ tree pics
Expand Down Expand Up @@ -191,10 +191,7 @@ Linking directory 'pics'.
[##############################] 100% pics

Saving information to 'pics.dvc'.

To track the changes with git run:

git add pics.dvc
...
```

There are no DVC-files generated within this directory structure, but the images
Expand Down
2 changes: 1 addition & 1 deletion static/docs/commands-reference/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ into play. It handles that last step of adding the file to the DVC cache.
## Examples

To explore `dvc commit` let's consider a simple pipeline with several stages:
the example workspace used in the [Getting Started](/doc/get-started) tutorial.
the example workspace used in the [Get Started](/doc/get-started) section.

<details>

Expand Down
2 changes: 1 addition & 1 deletion static/docs/commands-reference/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ usually helps to save some space.
project is a path) to keep data that is currently referenced from them.

- `-c`, `--cloud` - also remove files in the remote storage. _This operation is
dangerous._ It removes data sets, models, other files that are not linked in
dangerous._ It removes datasets, models, other files that are not linked in
the current branch/commit (unless `-a` or `-T` is specified).

- `-r`, `--remote` - name of the remote storage to collect unused objects from
Expand Down
16 changes: 8 additions & 8 deletions static/docs/commands-reference/get-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ single-purpose command that can be used out of the box after installing DVC.

DVC supports several types of (local or) remote locations (protocols):

| Type | Discussion | URL format |
| ------- | ------------------------------------------------------- | ------------------------------------------ |
| `local` | Local path | `/path/to/local/file` |
| `s3` | Amazon S3 | `s3://mybucket/data.csv` |
| `gs` | Google Storage | `gs://mybucket/data.csv` |
| `ssh` | SSH server | `ssh://user@example.com:/path/to/data.csv` |
| `hdfs` | HDFS | `hdfs://user@example.com/path/to/data.csv` |
| `http` | HTTP to file with _strong ETag_ (see explanation below) | `https://example.com/path/to/data.csv` |
| Type | Discussion | URL format |
| ------- | -------------- | ------------------------------------------ |
| `local` | Local path | `/path/to/local/file` |
| `s3` | Amazon S3 | `s3://mybucket/data.csv` |
| `gs` | Google Storage | `gs://mybucket/data.csv` |
| `ssh` | SSH server | `ssh://user@example.com:/path/to/data.csv` |
| `hdfs` | HDFS | `hdfs://user@example.com/path/to/data.csv` |
| `http` | HTTP to file | `https://example.com/path/to/data.csv` |

> Depending on the remote locations type you plan to download data from you
> might need to specify one of the optional dependencies: `[s3]`, `[ssh]`,
Expand Down
6 changes: 3 additions & 3 deletions static/docs/commands-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ created in the current working directory, with its original file name.
> DVC is [installed](/doc/get-started/install).

We can use `dvc get` to download the resulting model file from our
[get started example](https://github.com/iterative/example-get-started), which
is a DVC project external to the current working directory). The desired file is
located in the root of the external repo, and named `model.pkl`.
[get started example repo](https://github.com/iterative/example-get-started),
which is a DVC project external to the current working directory). The desired
file is located in the root of the external repo, and named `model.pkl`.

```dvc
$ dvc get https://github.com/iterative/example-get-started model.pkl
Expand Down
Loading