-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add get-started page for AQ products
- Loading branch information
1 parent
25994e5
commit ec76e11
Showing
4 changed files
with
113 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
sidebar_label: Get Started | ||
title: 'Get Started | Cypress Accessibility Documentation' | ||
description: 'Set up Cypress Accessibility by recording a run. No code changes or configuration required.' | ||
sidebar_position: 20 | ||
--- | ||
|
||
# Get Started | ||
|
||
You don't need to make any changes to your code or your test setup. If you record test runs to the Cypress Cloud with Test Replay, you're ready to start using Cypress Accessibility. | ||
You'll start your free trial with personalized support from our sales team and your existing test data to instantly see full accessibility reports for all your Cypress projects. | ||
From there, you can integrate with CI to set your own standards for handling the results. | ||
|
||
## 1. Request a trial | ||
|
||
Get started with a free trial of Cypress Accessibility. You'll receive a personalized demo using your existing test data to see where testing gaps exist for all of your Cypress projects. | ||
|
||
<Btn | ||
label="Request trial ➜" | ||
variant="purple-dark" | ||
href="https://www.cypress.io/accessibility?utm_medium=get-started-page&utm_source=docs.cypress.io&utm_content=Request%20trial" | ||
/> | ||
|
||
## 2. Record a run | ||
|
||
Cypress Accessibility generates reports using [Test Replay](/cloud/features/test-replay) data and requires Cypress v13+. No additional configuration or instrumentation is required to get started. | ||
|
||
[Record a run](/cloud/get-started/setup) to the Cypress Cloud with Test Replay to start using Cypress Accessibility. | ||
|
||
## 3. View your Accessibility results | ||
|
||
After recording a test run, you can view your Accessibility results in the Cypress Cloud via the **Accessibility** tab. | ||
|
||
<DocsImage | ||
src="/img/accessibility/core-concepts/cypress-accessibility-views-dashboard.png" | ||
alt="The Cypress Accessibility Views List, in context in Cypress Cloud, reflecting a run of the Cypress Realworld App where violations of accessibility rules were detected on multiple pages." | ||
/> | ||
|
||
## 4. Customize your results | ||
|
||
Cypress Accessibility provides flexible configuration options to customize your reports. You can configure: | ||
|
||
- [Element filters](/accessibility/configuration/elementfilters): specify selectors for elements that should be excluded from Accessibility scans | ||
- [View filters](/accessibility/configuration/viewfilters): specify URL patterns for URLs that should be excluded from Accessibility scans. Excluding a URL also excludes all links to that URL. | ||
- [Views](/accessibility/configuration/views): specify URL patterns that represent views | ||
|
||
To add or modify the configuration for your project, navigate to the **App Quality** tab in your project settings. | ||
|
||
<DocsImage | ||
src="/img/accessibility/configuration/cypress-accessibility-configuration-editor.png" | ||
alt="The Cypress Cloud UI showing the configuration editor" | ||
/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: 'Get Started | UI Coverage Documentation' | ||
description: 'Set up UI Coverage by recording a run. No setup or instrumentation is required.' | ||
sidebar_label: Get Started | ||
sidebar_position: 20 | ||
--- | ||
|
||
# Get Started | ||
|
||
UI Coverage works instantly, with no setup or code instrumentation required. If you record test runs to the Cypress Cloud with Test Replay, you're ready to start using UI Coverage. | ||
You'll start your free trial with personalized support from our sales team and your existing test data to instantly see where testing gaps exist for all of your Cypress projects. | ||
From there, you can easily customize reports to fit your needs with flexible configuration options. | ||
|
||
## 1. Request a trial | ||
|
||
Get started with a free trial of UI Coverage. You'll receive a personalized demo using your existing test data to see where testing gaps exist for all of your Cypress projects. | ||
|
||
<Btn | ||
label="Request trial ➜" | ||
variant="purple-dark" | ||
href="https://www.cypress.io/ui-coverage?utm_medium=get-started-page&utm_source=docs.cypress.io&utm_content=Request%20trial" | ||
/> | ||
|
||
## 2. Record a run | ||
|
||
UI Coverage generates reports using [Test Replay](/cloud/features/test-replay) data and requires Cypress v13+. No additional configuration or instrumentation is required to start using UI Coverage. | ||
|
||
[Record a run](/cloud/get-started/setup) to the Cypress Cloud with Test Replay to start using UI Coverage. | ||
|
||
## 3. View your UI Coverage results | ||
|
||
After recording a test run, you can view your UI Coverage results in the Cypress Cloud via the **UI Coverage** tab. | ||
|
||
<DocsImage | ||
src="/img/ui-coverage/get-started/uicov-docs-1.gif" | ||
alt="UI Coverage demo showing a mouse hovering and interacting with the UI of the Cloud product" | ||
noBorder="true" | ||
/> | ||
|
||
## 4. Customize your results | ||
|
||
UI Coverage provides flexible configuration options to customize your reports. You can configure: | ||
|
||
- [Attribute filters](/ui-coverage/configuration/attributefilters): specify patterns for attributes and their values that should not be used for identifying and grouping elements | ||
- [Element filters](/ui-coverage/configuration/elementfilters): specify selectors for elements that should be excluded from UI Coverage | ||
- [Element groups](/ui-coverage/configuration/elementgroups): groups elements that are related to one another | ||
- [Elements](/ui-coverage/configuration/elements): specify selectors to uniquely identify elements | ||
- [Significant Attributes](/ui-coverage/configuration/significantattributes): prioritize the identification and grouping of specific attributes | ||
- [View filters](/ui-coverage/configuration/viewfilters): specify URL patterns for URLs that should be excluded from UI Coverage. Excluding a URL also excludes all links to that URL. | ||
- [Views](/ui-coverage/configuration/views): specify URL patterns that represent views | ||
|
||
To add or modify the configuration for your project, navigate to the **App Quality** tab in your project settings. | ||
|
||
<DocsImage | ||
src="/img/accessibility/configuration/cypress-accessibility-configuration-editor.png" | ||
alt="The Cypress Cloud UI showing the configuration editor" | ||
/> |