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

dissolve the section use-cases of the docs #793

Closed
dashohoxha opened this issue Nov 15, 2019 · 5 comments
Closed

dissolve the section use-cases of the docs #793

dashohoxha opened this issue Nov 15, 2019 · 5 comments

Comments

@dashohoxha
Copy link
Contributor

The PR #784 deprecates the pages https://dvc.org/doc/use-cases/sharing-data-and-model-files and https://dvc.org/doc/use-cases/shared-development-server. So, after this PR is merged, these should be removed.

If they are removed, use-cases is left with only two pages:

The first one is too generic to be a use-case. Data Versioning is rather a core feature of DVC, it is it's cornerstone. I cannot imagine a case where DVC is used without data versioning. The content of the page is just a description of this feature followed by an example (and it also recommends to read the Versioning tutorial).
So, I think that this page can be removed.

The second page is about the case when DVC is used only as a dataset catalog, for versioning and publishing data, containing no data processing or stages. This page could be moved to the User Guide, maybe in the section HowTo (like: How to Build and Use a Data Registry).

If use-case pages are moved or deleted, then we should also fix any URLs from the other pages where they might be used. Maybe we need to do any URL redirections too, I am not sure (see also: #757).

@jorgeorpinel

This comment has been minimized.

@dashohoxha
Copy link
Contributor Author

I think that it is better to discuss this issue here, instead of discussing it as comments to a PR.

@dashohoxha dashohoxha reopened this Nov 25, 2019
@jorgeorpinel
Copy link
Contributor

Sorry, it's not a separate issue. Please don't reopen this. Thanks

@jorgeorpinel
Copy link
Contributor

p.s. we can discuss on Discord, please ping us there if you prefer.

@dashohoxha
Copy link
Contributor Author

p.s. we can discuss on Discord, please ping us there if you prefer.

I don't think that Discord is a better place for discussing issues.

You closed the issue without any proper discussion, without any explanations or reasons, without having any consensus on it (at least I was not aware of such a consensus). That's why I reopened it.
And the label "invalid" seems rude to me for an issue or a discussion.

@jorgeorpinel jorgeorpinel removed the A: docs Area: user documentation (gatsby-theme-iterative) label May 4, 2020
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

No branches or pull requests

2 participants