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

rewrite interactive tutorials #1400

Closed
2 tasks
shcheklein opened this issue Jun 7, 2020 · 11 comments
Closed
2 tasks

rewrite interactive tutorials #1400

shcheklein opened this issue Jun 7, 2020 · 11 comments
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints

Comments

@shcheklein
Copy link
Member

shcheklein commented Jun 7, 2020

Introduction of interactive tutorials was an important and good step, but content and structure is in a pretty bad shape. We need to:

  • Integrate the repo with them into dvc.org repo?
  • Review and delete overlapping, too niche scenarios
  • Review other tutorials content - we do strange things there (like use of --no-scm which is clearly not important) in the get started, etc.

I suggest we start by focusing on Get started scenario first (after the new Get started is implemented).

Then we need to decide on the docs end what are we doing with technical Use Cases, Tutorials, etc - we need to find some name for these "DVC recipes" (DVC applies to different real world situations), put all of them here and try to implement (reuse) interactive tutorials for them.

We need to create a some common framework to put example from command reference in to Katacoda. It means for example that we have multiple scenarios per page. Probably we will have some common code that runs before each scenario.

Making the first part - reviewing and writing Get Started a p1.

@shcheklein shcheklein added website: eng-doc DEPRECATED JS engine for /doc ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints A: website Area: website labels Jun 7, 2020
@kurianbenoy

This comment has been minimized.

@shcheklein

This comment has been minimized.

@shcheklein shcheklein added A: website Area: website and removed A: website Area: website labels Jul 13, 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 17, 2021

Integrate the repo with them into dvc.org repo

I can work on this one. Would you like to preserve the git history of katacoda-scenarios here? It can be possible to add it as a subtree or submodule to the base repo but I don't think it's necessary. @shcheklein @jorgeorpinel

@iesahin iesahin self-assigned this Feb 17, 2021
@jorgeorpinel
Copy link
Contributor

Would you like to preserve the git history of katacoda-scenarios here?

Only if they work (for the most part) on DVC 1.0, in which case the existing ones could be copied to the v1 branch of this repo. Then merge that to master (latest) so we can start updating them for 2.0 there.

Please no submodules/trees. What file structure are you thinking? Thanks

@iesahin
Copy link
Contributor

iesahin commented Feb 18, 2021

Actually I'm thinking to copy mentioned repo to the root of this one and put a file describing the root of the scenario tree to katacoda as described here.

dvc.org/
|  .git/
| katacoda/
| content/
| ...
|  katacoda.yaml

I think it would not worth it to preserve the git history. I'll just do a single commit to v1 and update on master. Is this plan OK?

@shcheklein
Copy link
Member Author

@iesahin is there a strong reason to migrate it into the single repo? If not, I would not worry too much about it and keep it in the second repo, I think we can create even a separate ticket to discuss that.

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Feb 20, 2021

It's the first bullet in this issue's description @shcheklein 🙂 but I do agree that's prob not very impactful. Actually updating the scenarios should be the first thing to do here.

Is this plan OK?

Seemed reasonable @iesahin except for katacoda.yaml (I'd just mention it in the README). But anyway, let's leave that subtask for later (updated issue desc.).

@jorgeorpinel
Copy link
Contributor

Hi @iesahin 👋 just for visibility, what's the overall status of this epic? I know the Get Started scenarios are all updated 🎉. What about Examples and Tutorials? Do you need help reviewing/deciding anything on those fronts? Is there a roadmap of which new scenarios (if any) will be added? Thanks!

@iesahin
Copy link
Contributor

iesahin commented Apr 8, 2021

Hi @jorgeorpinel I'll continue updating examples and tutorials. I containerized the GS scenarios and will continue to build containers for each scenario to test them continuously. Thanks.

@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) and removed p0-critical Affects users in a bad way at the moment website: eng-doc DEPRECATED JS engine for /doc A: website Area: website labels Apr 29, 2021
@shcheklein
Copy link
Member Author

@iesahin what is the status of this? can we now close it and move other things to a separate tickets?

@iesahin
Copy link
Contributor

iesahin commented Jul 12, 2021

There are tutorials besides the Get-Started and they need improvement but I think these should be with the individual tickets. As we improve GS docs, we need to apply parallel content to the scenarios. I think we can close this now. @shcheklein

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) ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints
Projects
None yet
Development

No branches or pull requests

4 participants