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

[WIP] Absorbing Understanding DVC into the User Guide #1351

Closed
wants to merge 7 commits into from
Closed

[WIP] Absorbing Understanding DVC into the User Guide #1351

wants to merge 7 commits into from

Conversation

VANRao-Stack
Copy link

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

This is no way the final version of what I aim to do, and some more editing and re-arranging is required, but I thought it would be a good idea for me to post this, so that we are all on the same page about the final structure of the user-guide. #425

@jorgeorpinel jorgeorpinel changed the title Absorbing Understanding DVC into the User Guide [WIP] Absorbing Understanding DVC into the User Guide May 25, 2020
@jorgeorpinel
Copy link
Contributor

This is no way the final version of what I aim to do

For future ref. there's a couple better ways to express this: use a draft PR (see https://github.blog/2019-02-14-introducing-draft-pull-requests/), or at least add [WIP] to the title, which I just did 😉

Comment on lines -1 to +3
# User Guide
# A More Comprehensive Understanding

Our guides describe the main DVC concepts and features comprehensively,
Our guides continues to describe the main DVC concepts and features comprehensively,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you explain the reason of this change? I don't understand how it addresses the task at hand 🙁

This file turns into the User Guide home at https://dvc.org/doc/user-guide.

Copy link
Author

Choose a reason for hiding this comment

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

This wasn't supposed to be the user guide home, I'm sorry but I think one of the changes I Meade locally didn't show up here, I'll continue to work

@jorgeorpinel
Copy link
Contributor

I'm confused by the path and naming of the files in this PR. Are you able to run the web app locally? It's all explained in the docs contrib guide, please go over that again.

Maybe the content changes here are usfeul so don't discard your branch, but I have to close this one too and ask you to go back to the whiteboard again please. See #425 (comment)

Thanks!

@jorgeorpinel
Copy link
Contributor

p.s. you can reach me or the team on Discord if you have questions about how the website works. We're happy to help

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