Skip to content

user guide: DVC Files and Directories - 1.0 updates#1370

Merged
jorgeorpinel merged 42 commits into
masterfrom
refactor/get-started-1.0
Jun 15, 2020
Merged

user guide: DVC Files and Directories - 1.0 updates#1370
jorgeorpinel merged 42 commits into
masterfrom
refactor/get-started-1.0

Conversation

@jorgeorpinel
Copy link
Copy Markdown
Contributor

@jorgeorpinel jorgeorpinel commented May 28, 2020

Completes #1367

See also iterative/example-repos-dev/pull/14

LOTS OF FILES CHANGES but these are the main ones:

  • user-guide/dvc-files-and-directories.md now also explains both .dvc files and dvc.yaml.
  • Most other changes are just the link update to the above guide.
  • Changes in content\docs\user-guide\basic-concepts update the DVC-file term usage (rel: term: stop using "DVC-file" and "stage file" #1366).
  • Avoid "meta" and "metafile" terms

@jorgeorpinel jorgeorpinel requested a review from dmpetrov May 28, 2020 07:17
@shcheklein shcheklein temporarily deployed to dvc-landing-refactor-ge-b8kp4g May 28, 2020 07:17 Inactive
@calibre-analytics

This comment has been minimized.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-b8kp4g May 28, 2020 08:36 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-b8kp4g May 28, 2020 16:51 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-b8kp4g May 28, 2020 17:17 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-b8kp4g May 28, 2020 19:20 Inactive
Comment thread content/docs/user-guide/dvc-metafile-formats.md Outdated
@jorgeorpinel jorgeorpinel changed the title Get Started: DVC 1.0 updates Get Started & DVC Metafiles Guide: DVC 1.0 updates May 28, 2020
@shcheklein

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@shcheklein
Copy link
Copy Markdown
Contributor

It feels like we can do a section DVC Files and Directories with a few subsections inside:

  1. .dvc directory
  2. data .dvc files
  3. pipelines .dvc.yaml`

In the index page we can show a tree of a DVC project for people to visualize what is going on.

WDYT?

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented May 31, 2020

we can do a section DVC Files and Directories with a few subsections inside
From #1370 (comment)

Yep, that's is a good plan @shcheklein. Will do that. ✅

@jorgeorpinel

This comment has been minimized.

@jorgeorpinel jorgeorpinel changed the title Get Started & DVC Metafiles Guide: DVC 1.0 updates Get Started & DVC Files Guide: DVC 1.0 updates Jun 2, 2020
@jorgeorpinel jorgeorpinel mentioned this pull request Jun 2, 2020
20 tasks
Comment thread content/docs/install/plugins.md
@jorgeorpinel jorgeorpinel changed the base branch from refactor/get-started-0.94 to master June 6, 2020 08:16
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 10:56 Inactive
@jorgeorpinel jorgeorpinel requested a review from shcheklein June 14, 2020 11:27
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 11:55 Inactive
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Comment thread content/docs/user-guide/dvc-files-and-directories.md
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 19:47 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 21:03 Inactive
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Copy link
Copy Markdown
Contributor

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

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

just one or two unresolved comments left? otherwise goo to go .. feel free to merge when you are done with them. Good stuff.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 23:28 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 23:43 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-refactor-ge-mr38no June 14, 2020 23:49 Inactive
@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

OK! Double checked CI test fail and it's just the new link. Also looked at preview app and it looks fine. Merging.

@jorgeorpinel jorgeorpinel merged commit 4e82857 into master Jun 15, 2020
@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

looked at preview app and it looks fine

p.s. it's getting pretty long though @shcheklein, should we make each file a sub-page? esp. when adding dvc.lock

@jorgeorpinel jorgeorpinel deleted the refactor/get-started-1.0 branch June 23, 2020 04:15
@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide labels Mar 16, 2023
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) C: guide Content of /doc/user-guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants