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

guide: split DVC Files/Internals (prep for dvc.yaml 2.0 updates) #2043

Merged
merged 6 commits into from
Dec 22, 2020

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Dec 21, 2020

Also includes

  • Separate Outputs and Dependencies sections in DVC Files guide

Next up:

@shcheklein shcheklein temporarily deployed to dvc-landing-dvc-yaml-pa-e4wbve December 21, 2020 23:05 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-dvc-yaml-pa-e4wbve December 21, 2020 23:08 Inactive
@jorgeorpinel jorgeorpinel marked this pull request as ready for review December 21, 2020 23:22
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-dvc-yaml-pa-e4wbve December 21, 2020 23:22 Inactive
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Dec 21, 2020

@ivan most files just have link updates, please focus on sidebar.json, user-guide/dvc-files.md, and user-guide/dvc-internals.md. The changes can be checked more easily in https://dvc-landing-dvc-yaml-pa-e4wbve.herokuapp.com/doc/user-guide

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-dvc-yaml-pa-e4wbve December 22, 2020 00:22 Inactive
Comment on lines +21 to +22
See the [internals guide](/doc/user-guide/dvc-internals) for the contents of the
`.dvc/` directory.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This link is meant to preserve/transfer the SEO ranking for the now separate guide on internals.

@shcheklein
Copy link
Member

there are failing links on CI^?

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-dvc-yaml-pa-e4wbve December 22, 2020 01:35 Inactive
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Dec 22, 2020

p.s. I almost forgot to update content/linked-terms.js and to add a redirects-list.json!

CI checks are passing now BTW 🙂

@jorgeorpinel

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Dec 22, 2020

OK I see the failed links now. These are fine, as they don't exist on prod yet. But they will soon, merging!

I did a sanity check of the redirect and .dvc, dvc.yaml auto-links in https://dvc-landing-dvc-yaml-pa-e4wbve.herokuapp.com/doc/user-guide/dvc-files-and-directories

@jorgeorpinel jorgeorpinel merged commit ecc0708 into master Dec 22, 2020
@jorgeorpinel
Copy link
Contributor Author

This also "applies" to v1 but no need to backport.

I guess we will need good reasons to backport things to v1 e.g. existing PRs (pre-2.0) and bug fixes.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Dec 22, 2020

⚠️ Hmmmm... https://dvc.org/doc/user-guide/dvc-files-and-directories is giving me a 404 but the redirect is there:

"^/doc/user-guide/dvc-files-and-directories$ /doc/user-guide/dvc-files",

I tested in the review app before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants