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.

Sign up for GitHub

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

Jump to bottom

misc. terminology clarifications et al. (Jun) #432

Closed
5 of 8 tasks
jorgeorpinel opened this issue Jun 11, 2019 · 1 comment · Fixed by #436
Closed
5 of 8 tasks

misc. terminology clarifications et al. (Jun) #432

jorgeorpinel opened this issue Jun 11, 2019 · 1 comment · Fixed by #436
Assignees
@jorgeorpinel
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 Jun 11, 2019 •
edited
Loading

  • The usage of "don't/doesn't" vs "do/does not" (the latter forms is more emphatic).
  • "Remote" vs "data remote" vs "DVC remote" (or even "DVC data remote"). Extracted to standardize "remote" related terms #440
  • Review Dvcfile usage and correctness.
  • Don't refer to "THE pipeline" as DVC projects support multiple pipelines: emphasize this somewhere in the docs
  • Should .dvc/cache directory always have a trailing / like .dvc/ ?
  • Some sub-commands need full command title e.g. # cache dir in /doc/commands-reference/cache-dir (It's currently only # dir)
  • "named" -> "given/target" in many cmd refs

Future?

  • Review usage of "DVC" branding of terms e.g. "DVC pipeline" or "DVC remote", etc.
  • Consistent use of "name.dvc stage file" vs "'name' stage" phrases
  • Review usage of term "step" (use "stage" when referring to pipelines).
@jorgeorpinel jorgeorpinel self-assigned this Jun 11, 2019
@jorgeorpinel jorgeorpinel mentioned this issue Jun 11, 2019
Closed
5 tasks
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions labels Jun 11, 2019
@shcheklein shcheklein changed the title docs: misc. terminology clarifications misc. terminology clarifications Jun 11, 2019
@jorgeorpinel jorgeorpinel changed the title misc. terminology clarifications misc. terminology clarifications et al. Jun 12, 2019
@jorgeorpinel jorgeorpinel mentioned this issue Jun 13, 2019
Merged
@jorgeorpinel
Copy link
Contributor Author

Sorry my bad, #436 didn't fully close this issue.

@jorgeorpinel jorgeorpinel reopened this Jun 17, 2019
@jorgeorpinel jorgeorpinel mentioned this issue Jun 22, 2019
Closed
7 tasks
@jorgeorpinel jorgeorpinel changed the title misc. terminology clarifications et al. misc. terminology clarifications et al. (Jun) Jul 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jorgeorpinel jorgeorpinel

Labels
A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[WIP] docs: regular update (mid June)
2 participants
@jorgeorpinel @shcheklein