adds entries for canceling and archiving runs to dashboard page (cypr…

…ess-io#2583)

* adds entries for cancelling and archiving runs to dashboard runs page, also adds managing runs section to dashboard introduction page.

* Update source/guides/dashboard/introduction.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update source/guides/dashboard/runs.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update source/guides/dashboard/runs.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update source/guides/dashboard/runs.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update source/guides/dashboard/runs.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* updates cancel run and archive run documentation per change requests -- adds URLs to cancel and archive sections in dashboard introduction, adds screenshot of error thrown in test runner after cancellation, some wording edits, clarifies whether cancelled and archived runs affect monthly test limit, and adds https:// to URL format for an archived run.

* Final updates for cancel & archive run

- Move sections to bottom (these are less important than the other
sections)
- Add subtitles to section, making everything bullet-point form.
- Clarify ‘existing instances’ and ‘active test runners’ to mean calls
to ‘cypress run —record’
- Highlight all ‘buttons’ with bold text and add fa icons where
applicable.
- Add image of what ‘archive this run’ looks like
- Crop images for ‘cancel run’ and ‘restore from archive’ to only
include necessary pixels.

* fix weird image placement...who knows.

* Fix broken links + final lint error

Co-authored-by: Jennifer Shehane <[email protected]>

source/guides/dashboard/introduction.md

@@ -28,6 +28,13 @@ From the Dashboard you can:
 
 {% imgTag /img/dashboard/dashboard-runs-list.png "Dashboard Screenshot" %}
 
+## Manage runs
+
+From the Dashboard you can:
+
+- {% url "Cancel runs" runs#Cancel-run %} currently in progress
+- {% url "Archive runs" runs#Archive-run %} in a canceled or errored state
+
 ## Manage organizations
 
 From the Dashboard you can:

source/guides/dashboard/runs.md

@@ -74,3 +74,50 @@ Any tests that fail during a test run can be found under the **Failures** tab. E
 - **Video:** The recorded video scrubbed to the point of failure in the test.
 
 {% imgTag /img/dashboard/failures-of-recorded-run.png "failure tab" %}
+
+# Cancel run
+
+You can cancel a run currently in progress from the Dashboard. Runs can only be canceled by members of the project.
+
+**To cancel a run**
+
+- Click on a run in progress from the run list
+- Click on **{% fa fa-ban %} Cancel run** in the upper-right corner of the run details page
+- Click **Yes, cancel this run** to confirm. **Note: this cannot be undone**
+
+{% video local /img/snippets/cancelling-run.mp4 %}
+
+**What happens when a run is canceled?**
+
+- The run status will update to canceled.
+- A message will appear on the run details page showing the time of cancellation and the user that canceled the run.
+- The run will display as **Canceled** in the associated GitHub pull request if {% url "GitHub Integration" github-integration %} is enabled.
+- Any tests recorded to completion will be available to view in the run details page.
+- Any tests recorded to completion will still count towards your monthly test recording limit.
+- If you have Analytics enabled, canceled runs will appear in the {% url "Runs over time" analytics#Runs-over-time %} chart.
+- Any incomplete calls to {% url "`cypress run --record`" command-line#cypress-run %} for the run will be marked as canceled and not run.
+- Any existing calls to {% url "`cypress run --record`" command-line#cypress-run %} for the run will exit with an error like below.
+  {% imgTag /img/dashboard/cancel-run-error.png "cancel-run-error" width-600 %}
+
+# Archive run
+
+Runs that have been canceled or are in an errored state can be archived from the Dashboard.
+
+**To archive a run**
+
+- In the cancellation or error message, click **Archive this run**.
+  {% imgTag /img/dashboard/archive-run-within-cancelation-msg.png "cancel-run-error" %}
+
+**What happens when a run is archived?**
+
+- The archived run will no longer display in the runs list or {% url "Analytics" analytics %} reporting.
+- Archived runs can be accessed by the URL to that run. The format is:
+  `https://dashboard.cypress.io/projects/{project ID}/runs/{run number}`
+- Any tests recorded to the Dashboard will still count towards your monthly test recording limit, even when it has been archived.
+
+**To restore an archived run**
+
+- Visit the archived run. The archived run can be accessed by the URL of the run. The format is:
+  `https://dashboard.cypress.io/projects/{project ID}/runs/{run number}`
+- Click **{% fa fa-history %} Restore from archive**
+  {% imgTag /img/dashboard/restore-from-archive.png "restore-from-archive" %}