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

ref: misc. improvements around "stage" concept #3235

Merged
merged 4 commits into from
Jan 29, 2022
Merged

ref: misc. improvements around "stage" concept #3235

merged 4 commits into from
Jan 29, 2022

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Jan 28, 2022

@jorgeorpinel jorgeorpinel added the p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. label Jan 28, 2022
@shcheklein shcheklein temporarily deployed to dvc-org-gst-pyxumv2ug2qqjrntgk January 28, 2022 05:59 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-gst-pyxumv2ug2qqjrntgk January 28, 2022 06:15 Inactive
@jorgeorpinel jorgeorpinel changed the title ref: misc. improvements around stage add ref: misc. improvements around "stage" concept Jan 28, 2022
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-gst-pyxumv2ug2qqjrntgk January 28, 2022 06:33 Inactive
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explanation of some changes 👇

Comment on lines 11 to -18
## Typical DVC workflow

- In an existing Git repository, initialize a <abbr>DVC project</abbr> with
`dvc init`.
- Copy data files or dataset directories for modeling into the repository, and
track them with DVC using the `dvc add` command.
- Process the data with your own source code, using `dvc.yaml` and/or the
`dvc stage add` command to specify further <abbr>outputs</abbr> that should
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ended up rewriting this whole section 😅

Freeze [stages](/doc/command-reference/stage) until `dvc unfreeze` is used on
Freeze [stages](/doc/command-reference/run) until `dvc unfreeze` is used on
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are for consistency (only place where stage ref is linked insted of run) for now. Wil be properly addressed in #2883.

_dvc stage add --plots file.csv ..._ command assign the default template that
needs to be changed in many cases. A simple command changes the template:
Something like `dvc stage add --plots file.csv ...` assigns the default
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can auto-link to https://dvc.org/doc/command-reference/stage/add#--plots directly from here now.

@jorgeorpinel jorgeorpinel marked this pull request as ready for review January 28, 2022 06:35
@jorgeorpinel jorgeorpinel self-assigned this Jan 28, 2022
Copy link
Contributor

@dberenbaum dberenbaum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One type, otherwise looks good!

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-gst-pyxumv2ug2qqjrntgk January 28, 2022 22:15 Inactive
@jorgeorpinel jorgeorpinel merged commit 311b554 into master Jan 29, 2022
@jorgeorpinel jorgeorpinel deleted the gst branch January 29, 2022 00:00
iesahin pushed a commit that referenced this pull request Apr 11, 2022
* ref: rewrite Typical Workflow in index page
rel. #3223 (comment)

* ref: link "stage" concept to `run` ref. for now
rel. #3223 (comment)

* ref: stage add --plots autolink from plots modify
per #3223 (comment)

* Update content/docs/command-reference/import-url.md

Co-authored-by: Dave Berenbaum <[email protected]>

Co-authored-by: Dave Berenbaum <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants