Skip to content

Cloud sidebar updates #5246

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

Merged
merged 53 commits into from
Jun 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
66cb41b
org content updates
jaffrepaul May 1, 2023
db85489
move billing & usage to separate page
jaffrepaul May 15, 2023
0634c4b
group content by feature
jaffrepaul May 15, 2023
e651e45
structure to match cypress.io
jaffrepaul May 18, 2023
41dd5a4
rename runs -> project health
jaffrepaul May 19, 2023
dfb4289
reorder account management content
jaffrepaul May 19, 2023
f0daeeb
move parallelization page to cloud section
jaffrepaul May 19, 2023
8aa20f8
move prioritization -> load balance
jaffrepaul May 19, 2023
d94e3d9
move smart orchestration content -> spec prioritization & auto cancel…
jaffrepaul May 19, 2023
8c57e95
move flaky test management -> visual reviews/flake detection
jaffrepaul May 19, 2023
da51424
move flake detection -> test analytics/flake detection
jaffrepaul May 19, 2023
b1ae0be
move jira integration -> integrated workflows/issue creation
jaffrepaul May 19, 2023
d6d4ee6
move slack & teams integration -> integrated workflows/failure notifi…
jaffrepaul May 22, 2023
af4d151
move gh,gl,bb integrations -> integrated workflows/pull request review
jaffrepaul May 22, 2023
77f03e5
move sso -> integrated workflows/team auth
jaffrepaul May 22, 2023
508a6cf
remove features parent grouping & lint
jaffrepaul May 22, 2023
6ccd91d
cleanup
jaffrepaul May 22, 2023
7df261a
set broken links to warn for review build
jaffrepaul May 22, 2023
63ae593
move account management -> /getting started
jaffrepaul May 23, 2023
b89c9cc
reorganize integrations
jaffrepaul May 23, 2023
070c7ac
adjust sidebar children size
jaffrepaul May 22, 2023
8fdb920
separate getting started & revert flaky test management
jaffrepaul May 30, 2023
59cc75d
reorder account management content
jaffrepaul May 30, 2023
2f9e6ec
rename sso page
jaffrepaul May 30, 2023
c8a5d3d
add app cloud page & reorder sidebar
jaffrepaul May 30, 2023
5ba9cf5
add app integration content from app section
jaffrepaul Jun 1, 2023
02bae92
1st pass url updates
jaffrepaul Jun 1, 2023
9e3fb9c
lint
jaffrepaul Jun 1, 2023
34fff50
update app cloud relative links
jaffrepaul Jun 2, 2023
9497ec5
move smart orchestration bullets into associated page
jaffrepaul Jun 2, 2023
c9f3559
more content link fixes
jaffrepaul Jun 2, 2023
b89c0fa
1st pass new FE redirects
jaffrepaul Jun 2, 2023
451afc8
lint
jaffrepaul Jun 2, 2023
ca9d3b9
revert project heath name -> runs
jaffrepaul Jun 5, 2023
1bc8109
lint
jaffrepaul Jun 5, 2023
8d90849
rename auto run cancellation -> run cancellation
jaffrepaul Jun 8, 2023
b2ecd68
visualreview
jaffrepaul Jun 8, 2023
e771e4a
reorder content & fix links
jaffrepaul Jun 9, 2023
aa2deb8
lint
jaffrepaul Jun 9, 2023
c80ec4a
remove app integration content for now
jaffrepaul Jun 9, 2023
933dc04
redirect updates
jaffrepaul Jun 12, 2023
3b38a33
sidebar css
jaffrepaul Jun 12, 2023
d5e70cb
revert broken links to throw during build
jaffrepaul Jun 12, 2023
1b20fd9
lint
jaffrepaul Jun 12, 2023
efb8117
add content changes from PR review
jaffrepaul Jun 13, 2023
2e4ade3
Update docs/guides/cloud/introduction.mdx
jaffrepaul Jun 13, 2023
d9e5c4d
Update docs/guides/cloud/recorded-runs.mdx
jaffrepaul Jun 13, 2023
5d3fc02
Update docs/guides/cloud/account-management/projects.mdx
jaffrepaul Jun 13, 2023
727edd9
lint
jaffrepaul Jun 13, 2023
a12bc51
populate SO overview content & update links
jaffrepaul Jun 13, 2023
f574979
lint
jaffrepaul Jun 13, 2023
8f1401f
fix auto cancellation link
jaffrepaul Jun 13, 2023
c46c079
lint
jaffrepaul Jun 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/plugins/after-run-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ The `after:run` event fires after a run is finished. When running cypress via

When running via `cypress run`, the event will fire each time `cypress run`
executes. As a result, if running your specs in
[parallel](/guides/guides/parallelization), the event will fire once for each
machine on which `cypress run` is called.
[parallel](/guides/cloud/smart-orchestration/parallelization), the event will
fire once for each machine on which `cypress run` is called.

## Syntax

Expand Down
4 changes: 2 additions & 2 deletions docs/api/plugins/before-run-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ The `before:run` event fires before a run starts. When running cypress via
`cypress open`, the event will fire when opening a project.

The event will fire each time `cypress run` executes. As a result, if running
your specs in [parallel](/guides/guides/parallelization), the event will fire
once for each machine on which the tests are run.
your specs in [parallel](/guides/cloud/smart-orchestration/parallelization), the
event will fire once for each machine on which the tests are run.

## Syntax

Expand Down
45 changes: 24 additions & 21 deletions docs/faq/questions/cloud-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ You can read more [here](/guides/cloud/introduction).

## <Icon name="angle-right" /> How do I record my tests?

1. First [set up the project to record](/guides/cloud/projects#Setup).
2. Then [record your runs](/guides/cloud/runs).
1. First [set up the project to record](/guides/cloud/getting-started#Setup).
2. Then [record your runs](/guides/cloud/recorded-runs#Latest-Runs).

After recording your tests, you will see them in
[Cypress Cloud](https://on.cypress.io/cloud) and in the "Runs" tab.
Expand All @@ -42,8 +42,8 @@ the number of tests you record each month in your organization.

Tests are recorded when [cypress run](/guides/guides/command-line#cypress-run)
is called with the `--record` flag while supplying the record `--key`. This
means your [test run data](/guides/cloud/runs) is being "recorded" to Cypress
Cloud.
means your [test run data](/guides/cloud/recorded-runs#Latest-Runs) is being
"recorded" to Cypress Cloud.

We consider each time the `it()` function is called to be a single test. So you
will generally have several tests recorded within each spec file and likely
Expand All @@ -52,18 +52,19 @@ several spec files within a single run. Only the
are counted. The pending and skipped tests are NOT counted.

You can always see how many tests you've recorded from your organization's
[Billing & Usage](/guides/cloud/organizations#Billing-Usage) page within Cypress
Cloud.
[Billing & Usage](/guides/cloud/account-management/billing-and-usage) page
within Cypress Cloud.

## <Icon name="angle-right" /> What counts as a user?

A [user](/guides/cloud/users) is anyone with a login to Cypress Cloud who has
been invited to see and review the test results of your organization.
A [user](/guides/cloud/account-management/users) is anyone with a login to
Cypress Cloud who has been invited to see and review the test results of your
organization.

## <Icon name="angle-right" /> What if I can't access my Cypress Cloud account?

1. If you haven't signed up, see the
[Sign Up with an Invitation](/guides/cloud/users#Sign-Up-with-an-Invitation)
[Sign Up with an Invitation](/guides/cloud/account-management/users#Sign-Up-with-an-Invitation)
instructions.

2. Try resetting your password. If you never received the email, try the
Expand All @@ -83,10 +84,11 @@ similar to how public projects on Github, Travis, or CircleCI are handled.
Anyone who knows your `projectId` will be able to see the recorded runs,
screenshots, and videos for public projects.

**A private project** means that only [users](/guides/cloud/users) you
explicitly invite to your [organization](/guides/cloud/organizations) can see
its recorded runs. Even if someone knows your `projectId`, they will not have
access to your runs unless you have invited them.
**A private project** means that only
[users](/guides/cloud/account-management/users) you explicitly invite to your
[organization](/guides/cloud/account-management/organizations) can see its
recorded runs. Even if someone knows your `projectId`, they will not have access
to your runs unless you have invited them.

## <Icon name="angle-right" /> How is this different than CI?

Expand Down Expand Up @@ -131,7 +133,7 @@ any test results.

Your Organization ID is a unique identifier that is linked to your organization.
Instructions on how to find your ID are in the
[Cypress Cloud Guide.](/guides/cloud/organizations#Organization-ID)
[Cypress Cloud Guide.](/guides/cloud/account-management/organizations#Organization-ID)

## <Icon name="angle-right" /> What does Cypress record?

Expand All @@ -153,11 +155,12 @@ These will be added in subsequent releases.

## <Icon name="angle-right" /> Why is test parallelization based on spec files and not on the individual functions?

Cypress [test parallelization](/guides/guides/parallelization) is indeed based
on specs. For each spec Cypress scaffolds the new running context, in a sense
isolating each spec file from any previous spec files, and ensuring a clean
slate for the next spec. Doing this for each _individual_ test would be very
very expensive and would slow down the test runs significantly.
Cypress
[test parallelization](/guides/cloud/smart-orchestration/parallelization) is
indeed based on specs. For each spec Cypress scaffolds the new running context,
in a sense isolating each spec file from any previous spec files, and ensuring a
clean slate for the next spec. Doing this for each _individual_ test would be
very very expensive and would slow down the test runs significantly.

Spec file durations are also more meaningful and consistent than timings of
individual tests, we can order specs by the moving average of the previously
Expand Down Expand Up @@ -199,8 +202,8 @@ it might be good enough for the job.

## <Icon name="angle-right" /> Can I delete a run from Cypress Cloud?

You can [archive a run](/guides/cloud/runs#Archive-run) so that it does not
display in the runs list or in analytics.
You can [archive a run](/guides/cloud/recorded-runs#Archive-run) so that it does
not display in the runs list or in analytics.

**Note:** Archiving the recorded runs has no effect on the amount of tests
recorded and counted as your usage billed for the month.
Expand Down
20 changes: 11 additions & 9 deletions docs/faq/questions/using-cypress-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -603,7 +603,8 @@ parts of the longer user feature in the separate tests as described in

## <Icon name="angle-right" /> How can I parallelize my runs?

You can read more about parallelization [here](/guides/guides/parallelization).
You can read more about parallelization
[here](/guides/cloud/smart-orchestration/parallelization).

## <Icon name="angle-right" /> Can I run a single test or group of tests?

Expand Down Expand Up @@ -631,8 +632,8 @@ You can read more about uploading files in
## <Icon name="angle-right" /> What is the projectId for?

The `projectId` is a 6 character string that helps identify your project once
you've [set up your tests to record](/guides/cloud/runs). It's generated by
Cypress and typically is found in your
you've [set up your tests to record](/guides/cloud/recorded-runs#Latest-Runs).
It's generated by Cypress and typically is found in your
[Cypress configuration](/guides/references/configuration).

:::cypress-config-example
Expand All @@ -646,14 +647,15 @@ Cypress and typically is found in your
:::

For further detail see the
[Identification](/guides/cloud/projects#Identification) section of the
[Cypress Cloud](/guides/cloud/introduction) docs.
[Identification](/guides/cloud/account-management/projects#Identification)
section of the [Cypress Cloud](/guides/cloud/introduction) docs.

## <Icon name="angle-right" /> What is a Record Key?

A _Record Key_ is a GUID that's generated automatically by Cypress once you've
[set up your tests to record](/guides/cloud/runs). It helps identify your
project and authenticate that your project is even _allowed_ to record tests.
[set up your tests to record](/guides/cloud/recorded-runs#Latest-Runs). It helps
identify your project and authenticate that your project is even _allowed_ to
record tests.

You can find your project's record key inside of the _Settings_ tab.

Expand All @@ -664,8 +666,8 @@ You can find your project's record key inside of the _Settings_ tab.
/>

For further detail see the
[Identification](/guides/cloud/projects#Identification) section of the
[Cypress Cloud](/guides/cloud/introduction) docs.
[Identification](/guides/cloud/account-management/projects#Identification)
section of the [Cypress Cloud](/guides/cloud/introduction) docs.

## <Icon name="angle-right" /> How do I check that an email was sent out?

Expand Down
6 changes: 6 additions & 0 deletions docs/guides/cloud/account-management/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"label": "Account Management",
"position": 30,
"collapsible": true,
"collapsed": true
}
84 changes: 84 additions & 0 deletions docs/guides/cloud/account-management/billing-and-usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: Billing & Usage
sidebar_position: 50
---

:::info

## <Icon name="graduation-cap" /> What you'll learn

- How to identify Cypress Cloud billing & usage
- How to upgrade your Cypress Cloud plan
- How to apply for an Open Source (OSS) plan

:::

<DocsImage
src="/img/guides/cloud/billing/billing-and-usage-results.jpg"
alt="Billing and Usage Results"
/>

## Open Source Plan

To support the community, we provide the Open Source (OSS) plan to take
advantage of Cypress Cloud with unlimited test runs. To qualify, all Projects in
your Organization must meet the following criteria:

- Be a non-commercial entity
- Be [Public](https://on.cypress.io/projects#Change-project-access) in Cypress
Cloud
- Your Project source code is available in a public location with an
[OSI-approved license](https://opensource.org/licenses)
- Record minimum of 500
[tests](https://on.cypress.io/cloud-faq#What-counts-as-a-test-result) included
with the [Free Plan](https://www.cypress.io/pricing)

## Requesting OSS plan for an Org

:::info

<Icon name="exclamation-triangle" /> Personal organizations cannot be used with an
OSS plan.

:::

1. [Login](https://on.cypress.io/dashboard) to the Cypress Dashboard, or
[create an account](https://on.cypress.io/dashboard) if you are a new user.

2. Go the [Organizations page](https://on.cypress.io/dashboard/organizations) to
select the Organization you want to associate with an OSS plan. If you have
no Organizations, you can create one by clicking the **+ Create New
Organization** button.

<DocsImage
src="/img/guides/cloud/organizations/oss-plan-2-select-org.jpg"
alt="Select or add organization"
width="80%"
/>

3. Go to the **Billing & Usage** page, click **Upgrade** and then click on the
**Apply for an open source plan** link at the bottom of the page. _Note:
Access to all Projects must be set to **public** to enable this link._

<DocsImage
src="/img/guides/cloud/organizations/oss-plan-3-billing.jpg"
alt="Upgrade Plan"
/>
<DocsImage
src="/img/guides/cloud/organizations/oss-plan-4-billing.jpg"
alt="Click Apply for an open source plan"
/>

4. Fill in and submit the OSS plan request form.

<DocsImage
src="/img/guides/cloud/organizations/oss-plan-5-billing.jpg"
alt="OSS plan request form"
/>

5. You'll receive an email confirming your request. The Cypress Team will review
your request and, if approved, an OSS plan subscription will be applied to
your Organization.

If you have any questions regarding the OSS plan, please feel free
[contact us](mailto:hello@cypress.io).
Loading