uber-archive / vis-academy

A set of tutorials on how our frameworks make effective data visualization applications.

Home Page:http://vis.academy

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Changes to Section 1: Make a Map

jkarnowski opened this issue · comments

Remove the section "1. Start with a bare React Component" because this is redundant; we can assume someone going through this tutorial knows the file they will be in to write code and will see the starter code in the file when they open the folder in their text editor. And, we can assume basic React knowledge so when someone sees the starter code, they will know 'oh, this is a bare component that will only display a div with some text'

Rename the section to: "Build the basic Map"

  • Add a high level brief description of what you'll build by the end of this section. Possibly "You will render a map with basic properties that will make it interactive. This is the base we need to later add data overlays and create the interactions between layers."

A few small changes for a big impact:

  1. Move the 'checkout complete code..' to the end of this section.
  2. Start the section with a clear description of what they will build and why. Possibly "Setup a React Component with a viewport that includes: dimension, location, zoom and maxZoom."
  3. Would it make sense to have 'Add the map Component' as the first thing to do? Currently, you describe it right away in the first paragraph and then reference it in Adding Default Viewport State. So, make that the 1st thing to do (instead of step 3).
  4. Remove Step numbers (1,2,3..) because that will make it easier to maintain in the future. If you add / remove steps or change them around, you won't have to update all the numbers.
  5. For each step that requires someone to write code, start with the instructions for what to build. Then explain why it's important or how to build that. Then, have the code solution.