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

Fixes for Stages Scenario #41

Merged
merged 3 commits into from
Mar 10, 2021
Merged

Fixes for Stages Scenario #41

merged 3 commits into from
Mar 10, 2021

Conversation

iesahin
Copy link
Contributor

@iesahin iesahin commented Mar 10, 2021

Fixes #29

  • Please check missing "the", "a/an", commas, etc. throughout the scenarios
  • Done for the edited steps

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)

General

  • Replace ~/stages/ to ~/project/ to conform to other parts

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)
  • Intro and Step 1 merged. It takes time to install DVC and the requirements, and the page is supposed to be read during that.
  • "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
  • Nope, AFAIK. Even setting the starting directory with uieditorpath setting doesn't work. (Theoretically the editor should start at ~/project, but doesn't). IMO there should be a simpler editor for these things. The editor can be moved to another tab, but I think this layout is better for larger screens.

The new Step 1:

  • "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.
  • I prefer to be explicit for the first link in a scenario. People might be using the environment for the first time and it's not clear what the link does. (Does it open in another window, in another terminal, in the editor?)
  • 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
  • I could put a wink there 😉
  • These two are edited and moved to the intro.

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 🙂

This scenario is merged from two scenarios, stages and pipelines were distinct. Previous scenarios had barely any text, simply a bunch of commands. I prefer to explain why we do something at that point and it takes text, and removing duplicates is usually easier than writing the missing parts. Thank you very much.

  • updated intro for typos and changes ~/stages to ~/project
  • merged step1 and intro and other fixes in GS/Stages updated (1.0) #29
  • Edited some sentences and moved them to intro

@iesahin iesahin merged commit 6f871aa into master Mar 10, 2021
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 this pull request may close these issues.

GS/Stages updated (1.0)
1 participant