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

user-guide/get-started: reorganize "Understanding DVC" section #425

Closed
jorgeorpinel opened this issue Jun 7, 2019 · 26 comments · Fixed by #1581
Closed

user-guide/get-started: reorganize "Understanding DVC" section #425

jorgeorpinel opened this issue Jun 7, 2019 · 26 comments · Fixed by #1581
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start help wanted Contributors especially welcome p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jun 7, 2019

Files currently located in /static/docs/understanding-dvc/

Remove all the Understanding DVC docs and just rescue all that is unique and valuable into the get started and user guide docs.

UPDATES:

@jorgeorpinel jorgeorpinel self-assigned this Jun 7, 2019
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) get-started p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Jun 8, 2019
@ryokugyu
Copy link
Contributor

ryokugyu commented Jun 8, 2019

Will you please give an example of this for better understanding? @jorgeorpinel

@shcheklein
Copy link
Member

@ryokugyu for example:

How it works - should be reviewed, simplified. made actionable. move to the user guide
What is DVC - reviewed, moved to the user-guide

etc.

@dnabanita7

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@shcheklein

This comment has been minimized.

@dnabanita7

This comment has been minimized.

@jorgeorpinel jorgeorpinel changed the title unbundle "Understanding DVC" docs docs: unbundle "Understanding DVC" section Oct 9, 2019
@jorgeorpinel jorgeorpinel changed the title docs: unbundle "Understanding DVC" section docs: reorganize "Understanding DVC" section Oct 13, 2019
@dashohoxha

This comment has been minimized.

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions and removed get-started labels Jan 20, 2020
@jorgeorpinel jorgeorpinel changed the title docs: reorganize "Understanding DVC" section user-guide/get-started: reorganize "Understanding DVC" section Jan 20, 2020
@jorgeorpinel jorgeorpinel added good first issue Good for newcomers help wanted Contributors especially welcome labels May 19, 2020
@srishti-nema
Copy link
Contributor

srishti-nema commented May 20, 2020

I am appending here my ideas about how to reorganize "Understanding DVC", but it is clear that those pages need to be heavily rewritten and updated (not just moved around or relocated on the menu)...

This structure looks good 👍 I was wondering whether we can move The Privacy Policy structure as discussed in #987 (comment) and #144(comment) under one of these sections?

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented May 20, 2020

Actually that proposal while great when it was done may be outdated right now. The goal now is to reduce the amount of pages and absorb the unique information from Understanding DVC pages into existing User Guide pages as much as possible.

I was wondering whether we can move The Privacy Policy structure as discussed in #987 (comment) and #144(comment) under one of these sections?

Good finds (possibly removing GAPP from footer and from nav sidebar, which is now possible BTW). However, this is all unrelated to this issue.

Also, @srishti-nema as you're already assigned to #540 please focus on that for now.

@VANRao-Stack
Copy link

VANRao-Stack commented May 23, 2020

I am appending here my ideas about how to reorganize "Understanding DVC", but it is clear that those pages need to be heavily rewritten and updated (not just moved around or relocated on the menu)...

I have created a similar indexed version of absorbing DVC. I have incorporated certain facts that make it seem more in place, developing from how ML evolved to asking the right questions now. @jorgeorpinel, @shcheklein, if it's okay, should I create a PR?

@shcheklein
Copy link
Member

@VANRao-Stack sounds cool! could you outline the changes first?

@VANRao-Stack

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@VANRao-Stack

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented May 25, 2020

Thanks @VANRao-Stack. I still don't see a specific plan of what parts of Understanding DVC will go where in other existing doc sections. We'd like to see such a "map" as an initial plan. You also seem to have the intention to improve some of the content in question, which isn't bad, but that's not within the scope of this task, just deciding which parts to preserve, moving them, and changing their wording as needed to fit the new context...

How about this, just focus on one page (for example https://dvc.org/doc/understanding-dvc/collaboration-issues) and try to detail where you would move all that content into other sections of the docs, of which parts to just remove and why. You can submit a PR directly if that's easiest for you, or just post another comment with the plan here.

@VANRao-Stack

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@VANRao-Stack

This comment has been minimized.

@shcheklein

This comment has been minimized.

@VANRao-Stack

This comment has been minimized.

@jorgeorpinel jorgeorpinel removed the good first issue Good for newcomers label May 26, 2020
@jorgeorpinel

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented May 26, 2020

OR if you want a small subtask that helps advance this issue, how about this:

  • Go over each page and delete content that is 100% redundant with the other existing sections.

For example the first bullet in https://dvc.org/doc/understanding-dvc/how-it-works is pretty much covered in a few places: https://dvc.org/doc/tutorials/get-started/initialize and https://dvc.org/doc/command-reference/init

That should be a well-scoped and relatively easy PR to review.

@VANRao-Stack

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@VANRao-Stack

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

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: start Content of /doc/start help wanted Contributors especially welcome p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants