diff --git a/docs/source/guides/core-concepts/dead-simple-debugging.md b/docs/source/guides/core-concepts/dead-simple-debugging.md index b101d32956..f8d3f71635 100644 --- a/docs/source/guides/core-concepts/dead-simple-debugging.md +++ b/docs/source/guides/core-concepts/dead-simple-debugging.md @@ -73,4 +73,4 @@ Use {% url `.debug()` debug %} to quickly inspect any (or many!) part(s) of your Though Cypress has built out [an excellent GUI application](/guides/cypress-basics/overview-of-the-gui-tool.html) to help you understand what is happening in your app and your tests, there's simply no replacing all the amazing work browser teams have done on their built-in development tools. Once again, we see that Cypress goes _with_ the flow of the modern ecosystem, opting to leverage these tools wherever possible. -TODO: show how clicking commands populates the dev tools, demonstrate a few commands + diff --git a/docs/source/guides/integrating-cypress/dashboard-features.md b/docs/source/guides/integrating-cypress/dashboard-features.md index 54ca34dd4c..164d043dc1 100644 --- a/docs/source/guides/integrating-cypress/dashboard-features.md +++ b/docs/source/guides/integrating-cypress/dashboard-features.md @@ -27,11 +27,11 @@ Once you're logged into the {% url 'Dashboard' https://on.cypress.io/dashboard % **Here are some of our own public projects you can view:** -- [cypress-core-desktop-gui](https://dashboard.cypress.io/#/projects/fas5qd) -- [cypress-example-recipes](https://dashboard.cypress.io/#/projects/6p53jw) -- [cypress-example-kitchensink](https://dashboard.cypress.io/#/projects/4b7344) -- [cypress-example-todomvc](https://dashboard.cypress.io/#/projects/245obj) -- [cypress-example-piechopper](https://dashboard.cypress.io/#/projects/fuduzp) +- [{% fa fa-folder-open-o %} cypress-core-desktop-gui](https://dashboard.cypress.io/#/projects/fas5qd) +- [{% fa fa-folder-open-o %} cypress-example-recipes](https://dashboard.cypress.io/#/projects/6p53jw) +- [{% fa fa-folder-open-o %} cypress-example-kitchensink](https://dashboard.cypress.io/#/projects/4b7344) +- [{% fa fa-folder-open-o %} cypress-example-todomvc](https://dashboard.cypress.io/#/projects/245obj) +- [{% fa fa-folder-open-o %} cypress-example-piechopper](https://dashboard.cypress.io/#/projects/fuduzp) # Frequently Asked Questions @@ -42,7 +42,7 @@ Once you're logged into the {% url 'Dashboard' https://on.cypress.io/dashboard % After recording your tests, you will see them in the Dashboard and in the Desktop Application. -## How is this different than CI? +## {% fa fa-angle-right %} How is this different than CI? {% url 'Cypress is *complimentary* to your CI provider' continuous-integration %}, and plays a completely different role. @@ -52,7 +52,7 @@ The Cypress {% url 'Dashboard' https://on.cypress.io/dashboard %} provides you w When a run happens and a test fails - instead of going and inspecting your CI provider's `stdout` output, you can log into the {% url 'Dashboard' https://on.cypress.io/dashboard %} and see all of the `stdout` as well as any errors during failures, any screenshots taken, and an entire video recording of the tests run. -## How much does this cost? +## {% fa fa-angle-right %} How much does this cost? Everything is free while we are in Beta. @@ -60,11 +60,11 @@ In the future, we will charge per month for *private* projects offering a simila *Public* projects will be free, but will likely have a monthly usage cap on them. -## Can I host this myself? +## {% fa fa-angle-right %} Can I host this myself? No, although we are looking to build an on-premise version of the Dashboard for use in private clouds. If you're interested in our on-premise version, [let us know](mailto:hello@cypress.io)! -## Can I choose not to use it? +## {% fa fa-angle-right %} Can I choose not to use it? Yes. The dashboard is a separate service from the Desktop Application and will always remain optional. We hope you'll find a tremendous amount of value out of it, but it is not coupled to being able to run your tests. diff --git a/docs/source/guides/integrating-cypress/dashboard-projects.md b/docs/source/guides/integrating-cypress/dashboard-projects.md index 2617e55d0c..70edd2b286 100644 --- a/docs/source/guides/integrating-cypress/dashboard-projects.md +++ b/docs/source/guides/integrating-cypress/dashboard-projects.md @@ -23,33 +23,33 @@ During a run we record all failing tests, logs, screenshots, and videos and make **To setup a project to record:** -1. **Click on the "Runs" tab of your project, then click "Setup Project to Record".** +***1. Click on the "Runs" tab of your project, then click "Setup Project to Record".*** - ![Setup Project Screen](https://cloud.githubusercontent.com/assets/1271364/22803739/2d66f42a-eee4-11e6-9b84-bd2e73a523d0.png) +![Setup Project Screen](https://cloud.githubusercontent.com/assets/1271364/22803739/2d66f42a-eee4-11e6-9b84-bd2e73a523d0.png) -2. **Fill in the name of your project** (this is only for display purposes and can be changed later). +***2. Fill in the name of your project (this is only for display purposes and can be changed later).*** - ![Project Name in Setup Project](https://cloud.githubusercontent.com/assets/1271364/22700406/9b3bc416-ed28-11e6-995b-297350420cce.png) +![Project Name in Setup Project](https://cloud.githubusercontent.com/assets/1271364/22700406/9b3bc416-ed28-11e6-995b-297350420cce.png) -3. **Choose who owns the project.** You can personally own it or select an organization you've created. +***3. Choose who owns the project. You can personally own it or select an organization you've created.*** - Organizations work just like they do in Github. They enable you to separate your personal and work projects. {% url 'Read more about organizations' dashboard-organizations %}. +Organizations work just like they do in Github. They enable you to separate your personal and work projects. {% url 'Read more about organizations' dashboard-organizations %}. - ![Chosen Organization to Own](https://cloud.githubusercontent.com/assets/1271364/22700579/26353ba6-ed29-11e6-9510-5b7bf4a1cdd2.png) +![Chosen Organization to Own](https://cloud.githubusercontent.com/assets/1271364/22700579/26353ba6-ed29-11e6-9510-5b7bf4a1cdd2.png) -4. **Choose whether this project is Public or Private.** +***4. Choose whether this project is Public or Private.*** - - **A public project** can have its recordings and runs seen by *anyone*. Typically these are open source projects. +- **A public project** can have its recordings and runs seen by *anyone*. Typically these are open source projects. - - **A private project** restricts its access to *only users you invite* to see your Organization or your own projects. +- **A private project** restricts its access to *only users you invite* to see your Organization or your own projects. - ![Privacy of Project](https://cloud.githubusercontent.com/assets/1271364/22803847/95870626-eee4-11e6-9627-7c00e8b77519.png) +![Privacy of Project](https://cloud.githubusercontent.com/assets/1271364/22803847/95870626-eee4-11e6-9627-7c00e8b77519.png) -5. **Click "Setup Project".** +***5. Click "Setup Project".*** - ![screen shot 2017-02-12 at 3 46 30 pm](https://cloud.githubusercontent.com/assets/1268976/22866093/64a9fb4c-f13e-11e6-9ebe-980ec078ba4e.png) +![Setup Project](https://cloud.githubusercontent.com/assets/1268976/22866093/64a9fb4c-f13e-11e6-9ebe-980ec078ba4e.png) -Your tests runs are now ready to record. Typically you would record your runs when running in {% url 'Continuous Integration' continuous-integration %} but you can also record your runs from your local computer. +🎉 Your tests runs are now ready to record! Typically you would record your runs when running in {% url 'Continuous Integration' continuous-integration %} but you can also record your runs from your local computer. ## Record Test Runs diff --git a/docs/source/guides/integrating-cypress/dashboard-recorded-runs.md b/docs/source/guides/integrating-cypress/dashboard-recorded-runs.md index 23d96fe731..91e0ef9087 100644 --- a/docs/source/guides/integrating-cypress/dashboard-recorded-runs.md +++ b/docs/source/guides/integrating-cypress/dashboard-recorded-runs.md @@ -14,12 +14,8 @@ Recorded runs are the results and artifacts captured from your test runs. We capture the following: -- [Standard Output](#Standard-Output) -- [Test Failures](#Test-Failures) -- [Screenshots](#Screenshots) -- [Video](#Video) -## Standard Output +## {% fa fa-code fa-fw %} Standard Output Standard output includes details and summaries of your tests based on the {% url 'reporter' reporters %} you have set. By default it is the `spec` reporter. @@ -27,7 +23,7 @@ Standard output includes details and summaries of your tests based on the {% url You will also see a summary at the bottom indicating the files we've created during the recording. -## Test Failures +## {% fa fa-exclamation-triangle fa-fw %} Test Failures Any tests that fail during a test run can be found under the *Failures* tab. Each failure is listed under it's test title. @@ -39,13 +35,13 @@ Any tests that fail during a test run can be found under the *Failures* tab. Eac ![failures](https://cloud.githubusercontent.com/assets/1271364/22707770/dce3664e-ed41-11e6-84de-03acdc499daa.png) -## Screenshots +## {% fa fa-picture-o fa-fw %} Screenshots All screenshots taken during the test run can be found under the *Screenshots* tab. Both screenshots taken during failures and screenshots taken using the {% url `cy.screenshot()` screenshot %} command will show up here. Each screenshot includes the application under test as well as the Cypress Command Log. ![Screenshots](https://cloud.githubusercontent.com/assets/1271364/22707241/28bf50de-ed40-11e6-93a1-4e09c2767605.png) -## Videos +## {% fa fa-video-camera fa-fw %} Videos Any videos recorded during the test run can be found under the *Videos* tab. You can also download the video of a run. diff --git a/docs/source/img/guides/cypress-basics/overview-of-the-gui-tool/gui-diagram.png b/docs/source/img/guides/cypress-basics/overview-of-the-gui-tool/gui-diagram.png index 81f08f3fbd..27690678ee 100644 Binary files a/docs/source/img/guides/cypress-basics/overview-of-the-gui-tool/gui-diagram.png and b/docs/source/img/guides/cypress-basics/overview-of-the-gui-tool/gui-diagram.png differ