Skip to content
This repository has been archived by the owner on Jul 5, 2022. It is now read-only.

GS/Stages updated (1.0) #29

Closed
jorgeorpinel opened this issue Mar 8, 2021 · 1 comment · Fixed by #41
Closed

GS/Stages updated (1.0) #29

jorgeorpinel opened this issue Mar 8, 2021 · 1 comment · Fixed by #41

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Mar 8, 2021

https://katacoda.com/dvc/courses/get-started/stages

  • Please check missing "the", "a/an", commas, etc. throughout the scenarios

Intro:

  • "track, save and" -> "track, save, and"
  • "the parameters, and the outputs" -> "its parameters and outputs"
  • "with a pipeline" -> "with a data pipeline"? (preserve link)

Step 1:
this whole step is a 2nd intro without actionable items. It's probably too much reading, let's try to combine with the actual intro and/or integrate into the next step (please summarize explanations)

  • "We covered these steps in previous scenarios..." - All of this for example could be replaced by a link to the previous scenario.
  • "use the editor to browse the project" - BTW is it possible to open the IDE without the Welcome page? Minor

Step 2:

  • "You can click the link below" - Probably no need to be so explicit. It should be intuitive for the user to click on that link and understand what's going on. Just a general idea to make the text lighter.
  • head data ... -> These 2 can be replaced by ls data/prepared I think.
  • "Our goal is to create a project that classifies" -> "create a model", but this info should probably be in the intro? The sentence seems unrelated to this paragraph.
  • "In a world without DVC tasks" -> "DVC, tasks" but again this paragraph is a bit repetitive since we already said we're running the process manually first, and then we can move on to the benefits of using DVC instead (the rest could be implied). Trying to minimize long explanations from Katacoda
  • "prone to errors all we know..." -> Strange sentence

There's currently another 8 steps and I have a feeling they have too much text (especially for a 2-stage pipeline, it used to be 3 steps). It's probably longer than https://dvc.org/doc/start/data-pipelines itself. Let's just try to simplify this again, generalizing feedback from this and recent issues, and we can continue to review when there's a PR with the next iteration 🙂

@jorgeorpinel
Copy link
Contributor Author

Cc @iesahin

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant