docs: Updated 'What You'll Learn' sections to look nice

This commit is contained in:
Jennifer Shehane
2017-06-08 17:15:29 -04:00
parent d595fe27b2
commit 581598ec6e
11 changed files with 68 additions and 36 deletions
@@ -1,13 +1,16 @@
---
title: "Aliases: Variables in an Async World"
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- how Cypress's asynchronous nature makes it hard to use variables
- what Aliases are, how they simplify and enable reuse in your code
- how to use Aliases for DOM elements
- how to use Aliases for XHR requests
- How Cypress's asynchronous nature makes it hard to use variables
- What Aliases are, how they simplify and enable reuse in your code
- How to use Aliases for DOM elements
- How to use Aliases for XHR requests
{% endnote %}
# Async Challenges
@@ -1,13 +1,16 @@
---
title: Cypress in a Nutshell
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- what Cypress looks like
- how Cypress queries the DOM more safely than jQuery
- how Cypress manages subjects and chains of commands
- what assertions look like and how they work
{% endnote %}
{% note info Important! %}
**This is the single most important guide for understanding how to work with Cypress** to test your modern web application. Read it. Understand it. Ask questions about it so that we can improve it.
@@ -1,12 +1,15 @@
---
title: Dead Simple Debugging
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- how Cypress runs in the runloop with your code, keeping debugging simple and understandable for modern web developers
- how Cypress embraces the standard DevTools
- how and when to use `debugger` and the shorthand `.debug()` command
- How Cypress runs in the runloop with your code, keeping debugging simple and understandable for modern web developers
- How Cypress embraces the standard DevTools
- How and when to use `debugger` and the shorthand `.debug()` command
{% endnote %}
# Using `debugger`
@@ -1,8 +1,10 @@
---
title: Dealing with the Network
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- How Cypress enables you to isolate any or all of your front-end with [`cy.server()`](https://on.cypress.io/api/server) and [`cy.route()`](https://on.cypress.io/route)
- What tradeoffs we make when we stub our network requests
@@ -10,6 +12,7 @@ comments: true
- How to use Fixtures to reuse XHR responses
- How to use Aliases to refer back to XHR requests and wait on them
- How to write declarative tests that resist flake
{% endnote %}
# Testing Strategies
@@ -2,11 +2,13 @@ title: Overview of the GUI Tool
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- the names and purposes of the visual parts of the Cypress GUI tool
- how the tool behaves under different situations and inputs
- how the tool integrates the browser console experience
- The names and purposes of the visual parts of the Cypress GUI tool
- How the tool behaves under different situations and inputs
- How the tool integrates the browser console experience
{% endnote %}
# Overview
@@ -1,14 +1,17 @@
---
title: Stubs, Spies, Clocks
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- which libraries Cypress includes to provide typical testing functionality
- how to use stubs for asserting that code was called but preventing it from executing
- how to use spies for asserting that code was called without interfering with its execution
- how to control time for deterministically testing code that is time-dependent
- how Cypress improves and extends the included libraries
- Which libraries Cypress includes to provide typical testing functionality
- How to use stubs for asserting that code was called but preventing it from executing
- How to use spies for asserting that code was called without interfering with its execution
- How to control time for deterministically testing code that is time-dependent
- How Cypress improves and extends the included libraries
{% endnote %}
# Capabilities
@@ -1,13 +1,16 @@
---
title: Taking Screenshots and Recording Videos
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- how Cypress captures screenshots of test failures automatically
- how to manually grab your own screenshot
- how Cypress can record a video of the entire run
- some options of what to do with screenshot and video artifacts
{% endnote %}
# Screenshots
@@ -1,10 +1,13 @@
---
title: Installing Cypress
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- how to install Cypress on your project using `npm`
- How to install Cypress on your project using `npm`
{% endnote %}
# Installing via NPM
@@ -1,12 +1,15 @@
---
title: Testing Your App
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- the relationship between Cypress and your back-end
- how authentication trips impedes testability... but doesn't have to
- how sensitive Cypress is to errors from _anywhere_
- configuration options to ease your pain
- The relationship between Cypress and your back-end
- How authentication trips impedes testability... but doesn't have to
- How sensitive Cypress is to errors from _anywhere_
- Configuration options to ease your pain
{% endnote %}
# Once More With Feeling!
@@ -1,12 +1,15 @@
---
title: Why Cypress?
comments: true
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- how we think differently about testing the modern web
- what benefits Cypress can bring for your team
- what tradeoffs Cypress makes
- How we think differently about testing the modern web
- What benefits Cypress can bring for your team
- What tradeoffs Cypress makes
{% endnote %}
# Cypress in 10 Minutes
@@ -1,10 +1,13 @@
---
title: Writing Your First Test
---
# What You'll Learn
{% note info %}
### {% fa fa-graduation-cap %} What You'll Learn
- how test files are structured and executed
- basic web navigation, dom selection, and assertions
- How test files are structured and executed
- Basic web navigation, DOM selection, and assertions
{% endnote %}
# Visual Learners