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

term: stop using "DVC-file" and "stage file" #1366

Closed
jorgeorpinel opened this issue May 27, 2020 · 3 comments · Fixed by #2050
Closed

term: stop using "DVC-file" and "stage file" #1366

jorgeorpinel opened this issue May 27, 2020 · 3 comments · Fixed by #2050
Labels
A: docs Area: user documentation (gatsby-theme-iterative) help wanted Contributors especially welcome p1-important Active priorities to deal within next sprints

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented May 27, 2020

Extracted from #1255

After 1.0, the term DVC-file only refers to raw/initial data versioned with dvc add/import/import-url. however users seem to mostly refer to such files as "dvc file" or .dvc file or just [data].dvc. Since we have all these alternatives, let's remove the formal term DVC-file? Also since there's not dvc.yaml (pipelines file) which adds to the confusion.

We could also address the "import stage" check box from #608:

  • Eliminate "import stage" term. Just use imported .dvc file or something like that

I suggest we always use the specific [data].dvc form in our docs.

See these changes as an example of what to do: 1008321

UPDATE: Decided for .dvc file instead. See #1366 (comment) just below.

UPDATE: Similarly, we should stop using "stage file" in favor for .dvc file as well.

UPDATE: Do not include instances in DVC command output examples.

UPDATE: See #1366 (comment) for known progress

@jorgeorpinel jorgeorpinel added help wanted Contributors especially welcome type: discussion Requires active participation to reach a conclusion. A: docs Area: user documentation (gatsby-theme-iterative) p1-important Active priorities to deal within next sprints labels May 27, 2020
@shcheklein
Copy link
Member

Agreed. I haven't seen the [data].dvc form though - looks too complicated. We can just use .dvc files - very explicit and clear.

@jorgeorpinel jorgeorpinel changed the title term: stop using DVC-file? term: stop using DVC-file May 28, 2020
@jorgeorpinel jorgeorpinel removed the type: discussion Requires active participation to reach a conclusion. label May 28, 2020
@jorgeorpinel jorgeorpinel changed the title term: stop using DVC-file term: stop using "DVC-file and "stage file" Jun 2, 2020
@jorgeorpinel jorgeorpinel changed the title term: stop using "DVC-file and "stage file" term: stop using "DVC-file" and "stage file" Jun 2, 2020
@jorgeorpinel
Copy link
Contributor Author

@utkarshsingh99 I think this chore is a little too boring TBH, I don't want you to suffer with this any more! Can you just please remind us the list of files that have been done so far up to your 2nd PR (#1408)? Thanks again for the help, BTW! I'll take it from there.

If you want to upload the remaining changes you have to a new branch in your fork and open a draft PR so I can take it over that would also be OK, up to you.

@utkarshsingh99
Copy link
Contributor

Sure.

  1. Command Reference
  1. API Reference
  1. Install
  1. User-Guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) help wanted Contributors especially welcome p1-important Active priorities to deal within next sprints
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants