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

ui: add interactive tutorial links to the appropriate pages #670

Closed
kurianbenoy opened this issue Oct 3, 2019 · 17 comments
Closed

ui: add interactive tutorial links to the appropriate pages #670

kurianbenoy opened this issue Oct 3, 2019 · 17 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) A: website Area: website help wanted Contributors especially welcome

Comments

@kurianbenoy
Copy link
Contributor

This is to create an easier run time environment for our tutorials like how pytorch docs tutorial has:

https://pytorch.org/tutorials/beginner/blitz/tensor_tutorial.html
tutorial

@shcheklein shcheklein changed the title Create an interactive button to run google colabs, Katacode , kaggle kernels, github button for Get-started tutorial create an interactive button to run google colabs, Katacode , kaggle kernels, github button for Get-started tutorial Oct 3, 2019
@shcheklein
Copy link
Member

We can reuse Katacoda's scenarios @dashohoxha is building for this.

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) website: eng-doc DEPRECATED JS engine for /doc get-started labels Oct 3, 2019
@dashohoxha

This comment has been minimized.

@dashohoxha

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel jorgeorpinel changed the title create an interactive button to run google colabs, Katacode , kaggle kernels, github button for Get-started tutorial docs: add interactive button to run google Colabs, Katacode , Kaggle kernels, GitHub button for get-started Oct 9, 2019
@jorgeorpinel jorgeorpinel changed the title docs: add interactive button to run google Colabs, Katacode , Kaggle kernels, GitHub button for get-started docs: add interactive button to run google Colabs, Katacode , Kaggle kernels, GitHub button for get-started/ tutorials Oct 9, 2019
@jorgeorpinel jorgeorpinel changed the title docs: add interactive button to run google Colabs, Katacode , Kaggle kernels, GitHub button for get-started/ tutorials docs: add interactive button to run google Colabs, Katacoda, Kaggle kernels, GitHub button for get-started/ tutorials Oct 9, 2019
@jorgeorpinel jorgeorpinel changed the title docs: add interactive button to run google Colabs, Katacoda, Kaggle kernels, GitHub button for get-started/ tutorials engine: add interactive button to run google Colabs, Katacoda, Kaggle kernels, GitHub button for get-started/ tutorials Oct 9, 2019
@jorgeorpinel jorgeorpinel changed the title engine: add interactive button to run google Colabs, Katacoda, Kaggle kernels, GitHub button for get-started/ tutorials engine: add interactive button to run get-started/ tutorials as Google Colabs, Katacoda, Kaggle kernels, etc. Oct 9, 2019
@jorgeorpinel

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor

...we should start integrating it with the engine (add a button). Any suggestions on how can it look like?

Agree! That seems like the main purpose of this ticket 😋. As for how it can look, maybe pretty similar to the PyTorch tutorial link provided, image

@dashohoxha

This comment has been minimized.

@algomaster99
Copy link
Contributor

@shcheklein We have already hyperlinked it. https://dvc.org/doc/tutorials/interactive. Where are we planning to put the interactive buttons?

@shcheklein shcheklein changed the title engine: add interactive button to run get-started/ tutorials as Google Colabs, Katacoda, Kaggle kernels, etc. add interactive button to run get-started/ tutorials as Google Colabs, Katacoda, Kaggle kernels, etc. Oct 9, 2019
@shcheklein shcheklein added p1-important Active priorities to deal within next sprints website: design Website graphic design labels Oct 9, 2019
@kurianbenoy
Copy link
Contributor Author

So we're discarding Kaggle kernels for now right?

I don't even know what they are, but for me it is ok, as long as somebody is willing to work on them.

I feel there will be some maintenance challenges to support jupyter-notebook based interactive tutorials in Kaggle with DVC like @jorgeorpinel said for Documentation team. And to be honest a CLI tool like DVC is not best to be run in a notebook.

I have already added the get started tutorial as a jupyter notebook sometime back.

https://www.kaggle.com/kurianbenoy/introduction-to-data-version-control-dvc

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Oct 11, 2019

Agree, I think we should stick with Katacoda, and also ignoring Colab for now unless a contributor wants to develop and maintain that.

We have already hyperlinked it. https://dvc.org/doc/tutorials/interactive. Where are we planning to put the interactive buttons?

By "interactive button" we mean a pretty link right? Yeah it's just a matter of design. Refer to #670 (comment) and #670 (comment). I think whoever takes on this task should just come up with a suggestion as of where in the docs layout to place this.

Perhaps a first step is to implement automatic recognition of md links to katacoda.com/dvc/..., turning them into buttons, and let the doc writer decide where to put them in each doc. Or <button> tags with value="katacoda.com/dvc/...". Idk, just brainstorming here.

@iAdramelk iAdramelk self-assigned this Nov 27, 2019
shcheklein added a commit that referenced this issue Dec 4, 2019
[WIP] Add interactive button to run get-started/ tutorials as Google Colabs, Katacoda, Kaggle kernels, etc. #670
@jorgeorpinel jorgeorpinel changed the title add interactive button to run get-started/ tutorials as Google Colabs, Katacoda, Kaggle kernels, etc. ui: add interactive button to run Katacoda samples in get-started / tutorials Jan 19, 2020
@jorgeorpinel jorgeorpinel removed A: docs Area: user documentation (gatsby-theme-iterative) get-started labels Jan 19, 2020
@jorgeorpinel jorgeorpinel added p1-important Active priorities to deal within next sprints and removed p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Jan 19, 2020
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) and removed website: design Website graphic design website: eng-doc DEPRECATED JS engine for /doc labels Feb 4, 2020
@shcheklein shcheklein changed the title ui: add interactive button to run Katacoda samples in get-started / tutorials ui: add interactive tutorial links to the appropriate pages Feb 4, 2020
@jorgeorpinel jorgeorpinel added website: eng-doc DEPRECATED JS engine for /doc and removed A: docs Area: user documentation (gatsby-theme-iterative) labels May 3, 2020
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) A: website Area: website labels May 12, 2020
@jorgeorpinel jorgeorpinel added p0-critical Affects users in a bad way at the moment and removed p1-important Active priorities to deal within next sprints labels Nov 21, 2020
@iesahin
Copy link
Contributor

iesahin commented Feb 21, 2021

What's the current status about this ticket? GS pages seem to have links to scenarios. Is there anything that should be modified in the docs about this?

@shcheklein
Copy link
Member

GS is outdated, not all pages have Katakoda unfortunately, also consider the most recent update @dberenbaum is doing in #2195

@jorgeorpinel jorgeorpinel added website: ux Website UI/UX and removed p0-critical Affects users in a bad way at the moment A: docs Area: user documentation (gatsby-theme-iterative) labels Feb 22, 2021
@jorgeorpinel
Copy link
Contributor

I think ultimately #1400 is about the content itself, and this one is about the design. We have this now:

image

Wide screens

image

Narrow screens/mobile

I think if we are OK with that interface we could indeed close this. But I think the narrow/mobile view should spell out "Katacoda" at least.

@shcheklein
Copy link
Member

I think if we are OK with that interface we could indeed close this. But I think the narrow/mobile view should spell out "Katacoda" at least.

I think this not in the scope of this ticket, @jorgeorpinel

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) and removed website: ux Website UI/UX website: eng-doc DEPRECATED JS engine for /doc labels Feb 22, 2021
@shcheklein
Copy link
Member

I guess we need to close this one and create the new one ticket that is specifically focused on content, not ui/ux

@shcheklein
Copy link
Member

Since I see we go back and forth with labels, it's clear that we interpret in different ways

@jorgeorpinel
Copy link
Contributor

There's #1400 for the content so yes, I wanted to think this was about something else. Thanks!

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) A: website Area: website help wanted Contributors especially welcome
Projects
None yet
Development

No branches or pull requests

7 participants