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

Add an index page with pointers to the interactive lessons #650

Closed
wants to merge 2 commits into from

Conversation

@shcheklein shcheklein temporarily deployed to dvc-org-pr-650 September 27, 2019 13:33 Inactive
src/Nav/index.js Outdated Show resolved Hide resolved
Copy link
Member

@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.

See my comments. It's probably good opportunity to introduce the new level in the - Tutorials. And we need to come with a better name, Learn is too generic.

@dashohoxha
Copy link
Contributor Author

It's probably good opportunity to introduce the new level in the - Tutorials.

The way that I see the DVC journey of a new user is like this:

  1. He starts with learning and practicing the basics of DVC on the interactive Katacoda terminal (https://katacoda.com/dvc/courses/basics).
  2. He learns about how to install DVC on his environment (we need a top-level page for installation: make a top-level (user-guide level?) installation page #656)
  3. He continues by trying some of the tutorials on his environment. For this we need a "Tutorials" top-level item with an index page (see: build a "Tutorials" top-level index page #657). Here the first tutorial is the "Get Started Tutorial", and the rest are interactive Katacoda tutorials, like this one: https://katacoda.com/dvc/courses/tutorials/versioning
  4. Then he may visit Use Cases, User Guide, Commands Reference, etc. as he needs to learn more, not necessary sequentially.

That's why I proposed to put a link to https://katacoda.com/dvc/courses/basics on the top menu. Maybe we can use the button "Get Started" (on the top-right of the page) for this purpose.

@shcheklein
Copy link
Member

That's why I proposed to put a link to https://katacoda.com/dvc/courses/basics on the top menu. Maybe we can use the button "Get Started" (on the top-right of the page) for this purpose.

I think I've addressed this a little bit in a few other tickets. Also, the way I see any tutorial on a third-party resource - it's a complimentary but not a replacement for the main get started flow. The entry point should stay on dvc.org in a text form - I think it's a regular approach for the docs.

Also, I think the current "Katacoda" basics course is too complicated already (like XFS intro, dvc add -R, sed, going too deep into pipelines, etc) to replace the get started. It's already similar to the Tutorial we have in terms of time it take to complete them all (1h+?). (Current get started is too complicated also and should have some hair cut - some details should be moved to the UG.)

It would be great to have a button to go and experiment with each get started section online. To some extent the example-get-started Git repo was made for this. It has 8 to 10 tags - each tag is a single step. It should be easy to git clone a certain revision and start experimenting (demoing a command).

My suggestion is to make it a part of the Tutorials + put links to different parts of it where appropriate. When it has some parity in terms of simplicity and completes (introduces more or less all basic features of DVC) we can put a link to the very beginning of the current get started. We should try and put a button "Run online" to each get started DVC section.

Here the first tutorial is the "Get Started Tutorial", and the rest are interactive Katacoda tutorials, like this one: https://katacoda.com/dvc/courses/tutorials/versioning

the same here. I do see a lot of benefits having it in a runnable form, but it should be integrated properly into the text version, not replace it. Again, dependency on a third-party service is bad, not being able to just read the text (I would prefer to skim through one single page in many cases) is bad, limited ability to present the information (highlighting, linking to command reference) is bad.

@dashohoxha
Copy link
Contributor Author

It would be great to have a button to go and experiment with each get started section online. To some extent the example-get-started Git repo was made for this. It has 8 to 10 tags - each tag is a single step. It should be easy to git clone a certain revision and start experimenting (demoing a command).

We should try and put a button "Run online" to each get started DVC section.

I have actually had in mind something like this. I am going to do this next. Just created this issue: #664

@dashohoxha
Copy link
Contributor Author

My suggestion is to make it a part of the Tutorials

I am going to create soon a top level entry for Tutorials. I am going to link these interactive lessons from the index page of the Tutorials. We can change this structure later if needed.

Related: #657

@dashohoxha
Copy link
Contributor Author

Closing this in favor of #666

@dashohoxha dashohoxha closed this Oct 2, 2019
@dashohoxha dashohoxha deleted the learn-dvc branch October 5, 2019 12:59
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.

None yet

2 participants