-
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
Misc. updates #1945
Misc. updates #1945
Conversation
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 changes per #1941 (comment):
stages. DVC will track changes in them and reflect this in the output of | ||
`dvc status`. | ||
[stages](/doc/command-reference/run). DVC will track changes in them and reflect | ||
this in the output of `dvc status`. |
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.
to be honest mentioning dvc status
is strange here. The most important thing that it will for example detect this change on dvc repro
.
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.
Good point. I changed these texts in dd1501b for both external docs since describing what deps/outs are isn't a goal here.
In order to specify an external <abbr>dependency</abbr> for your stage, use the | ||
usual `-d` option in `dvc run` with the external path or URL to your desired | ||
file or directory. | ||
> Note [remote storage](/doc/command-reference/remote) is a separate feature. |
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.
why is it needed?
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.
Because we mention remotes before so it may be confusing.
Is a short note by the end of the section too much?
@@ -13,18 +13,16 @@ track data outside of the <abbr>project</abbr>. | |||
## How external outputs work | |||
|
|||
DVC can track existing files or directories on an external location with | |||
`dvc add` (`out` field). It can also create external files or directories as | |||
outputs for `dvc.yaml` files (only `outs` field, not metrics or plots). | |||
`dvc add`. It can also define external outputs for `dvc.yaml` stages to create. |
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.
DVC pipelines stages?
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.
Not seeing need to mention pipelines in these docs, we're already going over deps/outs and stages. Too many concepts otherwise, probably? You can click on "stage" to get to pipelines.
[external cache](/doc/use-cases/shared-development-server#configure-the-external-shared-cache) | ||
in the same external/remote file. | ||
|
||
> Note that [remote storage](/doc/command-reference/remote) is a separate |
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.
same here, why is it needed?
|
||
1. Adding a `dvc remote` to use as cache for data in the external location, and | ||
1. Adding a `dvc remote` in the same location as the desired outputs, and | ||
configure it as external <abbr>cache</abbr> with `dvc config`. |
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.
as an external cache?
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.
No "an" needed. Maybe "the" but it's OK like this too (generic to any hypothetical project), I think.
from S3 to process it. | ||
|
||
External <abbr>dependencies</abbr> and | ||
External dependencies and | ||
[external outputs](/doc/user-guide/managing-external-data) provide ways to track |
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.
track and version?
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.
Do we version dependencies? Only when they're outputs of a previous stage, I think.
I guess we do keep track of their versions in any case, but don't really control those versions if they are external.
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.
This sentence is about External dependencies and [external outputs]
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.
True. Updating in 60e8055.
|
||
Currently, the following types (protocols) of external dependencies are | ||
supported: | ||
DVC can track files or directories on an external location as |
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.
sounds like it repeats a lot of the previous paragraph?
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.
True 🤦. Updated in cfe6e07.
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.
looks good to me, a few minor questions
Merging this! (I have lots of staged regular updates 😅) but please follow up on any discussions above @shcheklein, and I'll address them in a coming up PR. |
Copy edits stashed from recent PRs