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

Issue 160 - Add tutorials section to docs #191

Merged
merged 17 commits into from
Nov 1, 2017
Merged

Issue 160 - Add tutorials section to docs #191

merged 17 commits into from
Nov 1, 2017

Conversation

avanslaars
Copy link
Contributor

Added top level tutorial section, along with the "Introduction", "Project setup" and "Testing inputs" pages for the "Build and test TodoMVC with Cypress" tutorial.
Closes #160, #173, #174, #177

@avanslaars avanslaars changed the title Issue 160 Issue 160 - Add tutorials section to docs Oct 31, 2017
- add box shadow + margin to videos
- move ‘what you’ll learn below videos’
- add specific ‘video’ layout that displays videos as larger
- remove most of content from introduction 😬
- add a ‘contents’ section to main page.
@jennifer-shehane
Copy link
Member

jennifer-shehane commented Oct 31, 2017

I had a lot of feelings on this, so much so that I branched from this PR here so you can preview: #192

My thoughts:

  • The videos should be front and center. The layout of the current 'guides' doesn't work. I made a VERY quick mockup of a 'video' layout, where there is no right side nav, the video is larger, and text content is below. I think we could make this better - emphasize how long the video is, maybe even put a little github logo of the author, well - anything! This should be about the video, not conform to our previous format.
  • The introduction is not that great. :( Sorry. It does explain what the tutorial will cover very clearly, but does not address the WHY. Why do I need to watch this? Why is this critical to me as a developer? What will I walk away knowing that I didn't know before? What can I tell my boss about why I need to spend an hour today watching these tutorials. Also - it's missing some of the core buzzwords. I know it doesn't like, teach you how to build a React app, but we're building a React app - this seems important to mention.
  • I still like the idea of the 'contents' table with how long the videos are. I know you said it like...doesn't totally work cause there's text content, but this is honestly about the videos I think.

@jennifer-shehane
Copy link
Member

  • I added tests for the tutorial pages
  • I added a 'More tutorials to come' at the bottom of the list.
  • I renamed the tutorial to 'Test a React Todo App', I think saying 'Build and test' is kind of a stretch since we start with 'starter' code. This is just common, how you should test things with true TDD imo. And the title just looks simpler. What do you think?

I think it's probably ok to push now. We can improve on the layout later as more videos come together.

@avanslaars
Copy link
Contributor Author

That all works for me. The reason I initially avoided React in the title was to prevent people who use Vue, Angular, etc from avoiding looking at it, but I guess we run the risk of those same devs just bailing out once they see React anyway.

Thanks for all your help in getting this ready.

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

Successfully merging this pull request may close these issues.

2 participants