guide: DVC Project concept page by jorgeorpinel · Pull Request #2754 · treeverse/dvc.org

jorgeorpinel · 2021-08-25T01:33:10Z

Per #550 epic

jorgeorpinel · 2021-08-25T03:14:45Z

Would appreciate a quick review @casperdcl 🙏

jorgeorpinel · 2021-08-31T07:56:08Z

Sign in to view

  repository). It will contain the `.dvc/` directory, as well as `dvc.yaml` and
-  `.dvc` files created with commands such as `dvc add` or `dvc run`.
+  `.dvc` files created with commands such as `dvc add` or `dvc run`.  
+  See [full concept](/doc/user-guide/basic-concepts/dvc-project).


auto-render if markdown (below) is non-empty?

Yes it was mentioned in #2453 (review) (well sort of -- auto-linking from Glossary) and discussed with the team but deemed not a priority (at all). Also related to #2755 (review)

p.s. created #2771

p.p.s. I did apply the suggestion in this review.

casperdcl · 2021-08-25T21:03:16Z

+Initialized by running `dvc init` in you <abbr>workspace</abbr> directory, it
+will contain all the [DVC files and directories][dvc-metafiles] including the
+<abbr>cache</abbr>, `dvc.yaml` and `.dvc` files, etc. Any other files referenced
+from these DVC metafiles are also considered part of the project (for example
+[metrics files](/doc/command-reference/metrics)).


Suggested change

Initialized by running `dvc init` in you <abbr>workspace</abbr> directory, it

will contain all the [DVC files and directories][dvc-metafiles] including the

<abbr>cache</abbr>, `dvc.yaml` and `.dvc` files, etc. Any other files referenced

from these DVC metafiles are also considered part of the project (for example

[metrics files](/doc/command-reference/metrics)).

Initialized by running `dvc init` in your <abbr>workspace</abbr> directory, a

DVC project will contain all of the [DVC metafiles and

directories][dvc-metafiles] -- <abbr>cache</abbr>, `dvc.yaml`, `.dvc` files,

etc. Any other files referenced from these DVC metafiles are also considered

part of the project (e.g. [metrics files](/doc/command-reference/metrics)).

Thanks for the suggestion but I think both are valid since this text is right under the DVC Project title (so that's clearly what "it" refers to, I think). Stylistic

Oh I see there's another copy edit that changes `"including" for long dash. Same thing though, both are valid I think. I incline to keep mine of course unless there's an error somewhere.

Suggested change

Initialized by running `dvc init` in you <abbr>workspace</abbr> directory, it

will contain all the [DVC files and directories][dvc-metafiles] including the

<abbr>cache</abbr>, `dvc.yaml` and `.dvc` files, etc. Any other files referenced

from these DVC metafiles are also considered part of the project (for example

[metrics files](/doc/command-reference/metrics)).

Initialized by running `dvc init` in your <abbr>workspace</abbr> directory, a

DVC project will contain all of the [DVC metafiles and

directories][dvc-metafiles], such as the <abbr>cache</abbr>, `dvc.yaml`, and

`.dvc` files. Any other files referenced from these DVC metafiles are also

considered part of the project (e.g. [metrics

files](/doc/command-reference/metrics)).

lots of typos as well. compromised.

What typos?

casperdcl · 2021-08-25T21:05:25Z

+A DVC project in a Git repository can also be called _DVC repository_ or "the
+repo". This setup enables the
+[versioning features](/doc/start/data-and-model-versioning) of DVC
+(recommended). Files tracked by Git are considered part of the DVC project when
+referenced from DVC metafiles such as `dvc.lock`, for example source code that
+is used as a <abbr>stage</abbr> command (`cmd` field in `dvc.yaml`).


Suggested change

A DVC project in a Git repository can also be called _DVC repository_ or "the

repo". This setup enables the

[versioning features](/doc/start/data-and-model-versioning) of DVC

(recommended). Files tracked by Git are considered part of the DVC project when

referenced from DVC metafiles such as `dvc.lock`, for example source code that

is used as a <abbr>stage</abbr> command (`cmd` field in `dvc.yaml`).

A DVC project in a Git repository can also be called a _DVC repository_ or "the

repo". This setup enables the

[versioning features](/doc/start/data-and-model-versioning) of DVC

(recommended). Files tracked by Git are considered part of the DVC project when

referenced from DVC metafiles such as `dvc.lock` -- e.g. source code that is

used as a <abbr>stage</abbr> command (`cmd` field in `dvc.yaml`).

Again thanks but I prefer , for example. It's simpler and hopefully easier to read.

Suggested change

A DVC project in a Git repository can also be called _DVC repository_ or "the

repo". This setup enables the

[versioning features](/doc/start/data-and-model-versioning) of DVC

(recommended). Files tracked by Git are considered part of the DVC project when

referenced from DVC metafiles such as `dvc.lock`, for example source code that

is used as a <abbr>stage</abbr> command (`cmd` field in `dvc.yaml`).

A DVC project in a Git repository can also be called a _DVC repository_ or "the

repo". This setup enables the

[versioning features](/doc/start/data-and-model-versioning) of DVC

(recommended). Files tracked by Git are considered part of the DVC project when

referenced from DVC metafiles such as `dvc.lock`; for example source code that

is used as a <abbr>stage</abbr> command (`cmd` field in `dvc.yaml`).

Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

rl #2754 (comment)

shcheklein · 2021-08-31T18:07:17Z

+
+Initialized by running `dvc init` in your <abbr>workspace</abbr> directory, a
+DVC project will contain all of the [DVC metafiles and
+directories][dvc-metafiles], such as the <abbr>cache</abbr>, `dvc.yaml`, and


cache location can be changed though

yes, but explicitly stating that here may seem tangential/distract from the point? I don't have strong opinions here. The <abbr/> tooltip will of course provide more details.

cache location can be changed

"such as" leaves room for that.

jorgeorpinel · 2021-09-01T04:31:30Z

The changes in 4f62edc are completely stylistic. Please don't overwrite/force push over team members work without a good reason when reviewing @casperdcl . We only take over contributions from other teams or external (or if agreed).

casperdcl · 2021-09-01T13:24:55Z

What typos?

and

The changes in 4f62edc are completely stylistic

not so. you -> your, called DVC repo -> called a DVC repo. Reverted the emdash which you requested removed.

Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

guide: start DVC Project concept page

1d6f7b9

shcheklein temporarily deployed to dvc-org-guide-concepts--pbhe3l August 25, 2021 01:33 Inactive

jorgeorpinel mentioned this pull request Aug 25, 2021

guide: new DVC Concepts section #550

Closed

14 tasks

jorgeorpinel self-assigned this Aug 25, 2021

guide: finalize Project/Repo page

0b740b9

jorgeorpinel marked this pull request as ready for review August 25, 2021 03:13

jorgeorpinel temporarily deployed to dvc-org-guide-concepts--pbhe3l August 25, 2021 03:13 Inactive

guide: fix link in Project concept page

a1ae220

jorgeorpinel requested a review from casperdcl August 25, 2021 03:14

jorgeorpinel temporarily deployed to dvc-org-guide-concepts--pbhe3l August 25, 2021 03:14 Inactive

casperdcl suggested changes Aug 25, 2021

View reviewed changes

casperdcl added the A: docs Area: user documentation (gatsby-theme-iterative) label Aug 25, 2021

Merge branch 'master' into guide/concepts/project

4dc9992

jorgeorpinel temporarily deployed to dvc-org-guide-concepts--pbhe3l August 31, 2021 07:48 Inactive

Update content/docs/user-guide/basic-concepts/dvc-project.md

b8564a9

Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

jorgeorpinel temporarily deployed to dvc-org-guide-concepts--pbhe3l August 31, 2021 07:57 Inactive

concept: workspace copy edit

07d90a5

rl #2754 (comment)

jorgeorpinel temporarily deployed to dvc-org-guide-concepts--pbhe3l August 31, 2021 07:58 Inactive

jorgeorpinel requested a review from casperdcl August 31, 2021 08:05

shcheklein temporarily deployed to dvc-org-guide-concepts--pbhe3l August 31, 2021 11:14 Inactive

fix typos, grammar, punctuation

4f62edc

casperdcl force-pushed the guide/concepts/project branch from 51200ca to 4f62edc Compare August 31, 2021 11:18

shcheklein temporarily deployed to dvc-org-guide-concepts--pbhe3l August 31, 2021 11:18 Inactive

casperdcl approved these changes Aug 31, 2021

View reviewed changes

shcheklein reviewed Aug 31, 2021

View reviewed changes

shcheklein approved these changes Aug 31, 2021

View reviewed changes

casperdcl merged commit 5d4b5a1 into master Aug 31, 2021

casperdcl deleted the guide/concepts/project branch August 31, 2021 18:39

karajan1001 pushed a commit to karajan1001/dvc.org that referenced this pull request Sep 29, 2021

guide: DVC Project concept page (treeverse#2754)

84163bf

Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

Conversation

jorgeorpinel commented Aug 25, 2021

Uh oh!

jorgeorpinel commented Aug 25, 2021

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

jorgeorpinel Aug 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Aug 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Sep 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel commented Sep 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

casperdcl commented Sep 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jorgeorpinel Aug 31, 2021 •

edited

Loading

jorgeorpinel Aug 31, 2021 •

edited

Loading

jorgeorpinel Sep 1, 2021 •

edited

Loading

jorgeorpinel commented Sep 1, 2021 •

edited

Loading