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

standard way to refer to DVC-files and other terms #321

Closed
5 tasks done
jorgeorpinel opened this issue May 13, 2019 · 4 comments · Fixed by #422 or #433
Closed
5 tasks done

standard way to refer to DVC-files and other terms #321

jorgeorpinel opened this issue May 13, 2019 · 4 comments · Fixed by #422 or #433
Labels
A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented May 13, 2019

There 's several ways in which the docs refer to DVC-files (meaning the stage files created by dvc add, dvc run, etc, with the .dvc file extension).

Standardize everything to "DVC-file(s)" throughout the docs EXCEPT if the phrase is used for OTHER DVC-related files (not stage files) i.e. in "DVC Files and Directories":

  • "DVC file" and plural "DVC files". <-- Do NOT use for stage files

  • "DVC-file" and its plural "DVC-files". <-- Use this one

  • ".dvc file(s)" or ".dvc file extension" <-- Avoid except in single doc where DVC-files are described

  • "stage file(s)" <-- Avoid except when in the context of data pipelines

    ^ Partially extracted this case to there's ambiguity between the terms "stage" and "stage file" #423

  • DVC "metafile(s)"/"meta file(s)" <-- Avoid except in single doc where DVC-files are described

UPDATE: Other interesting phrases to review are: See #432

@jorgeorpinel

This comment has been minimized.

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions labels May 13, 2019
@shcheklein

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@shcheklein shcheklein changed the title Standardize the way to refer to DVC-files standardize the way to refer to DVC-files May 13, 2019
@jorgeorpinel jorgeorpinel changed the title standardize the way to refer to DVC-files Standard way to refer to DVC-files May 15, 2019
@shcheklein shcheklein changed the title Standard way to refer to DVC-files standard way to refer to DVC-files May 15, 2019
@jorgeorpinel jorgeorpinel changed the title standard way to refer to DVC-files standard way to refer to DVC-files and other terms May 30, 2019
@jorgeorpinel
Copy link
Contributor Author

Sorry, 2 of the checkboxes in the original description weren't completed with the PR that closed this. Reopened this issue and opened PR #433

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) type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants