Skip to content

Commit ab5496b

Browse files
MandroideMandroide
authored
Merge branch 'main' into docs-api-commands-fixture-global-this
2 parents eafaef6 + 94e7236 commit ab5496b

File tree

10 files changed

+168
-183
lines changed

10 files changed

+168
-183
lines changed

‎docs/examples/docker.mdx

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 40
99

1010
This repo holds various Docker images for running Cypress locally and in CI.
1111

12-
There are Docker images:
12+
The Docker images:
1313

1414
- `cypress/base:<Node version>` has the operating system dependencies required
1515
to run Cypress.
@@ -18,25 +18,5 @@ There are Docker images:
1818
pre-installed Cypress versions.
1919
- `cypress/factory:<tag>` is a docker image that can be used with docker args to
2020
generate a docker container with specific versions of node, yarn, chrome,
21-
firefox, edge and cypress. It is used to create the above docker images and
22-
can be used by you to create a custom docker image with versions of your
23-
choice.
24-
25-
## Examples
26-
27-
| Name | Description |
28-
| --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
29-
| <Icon name="github" /> [GitLab](https://gitlab.com/cypress-io/cypress-example-docker-gitlab) | Run Cypress tests in Docker on [GitLab](https://gitlab.com/) |
30-
| <Icon name="github" /> [CircleCI 2.0](https://github.com/cypress-io/cypress-example-docker-circle) | Run Cypress tests in Docker on [Circle 2.0](https://circleci.com) |
31-
| <Icon name="github" /> [CircleCI Workflows](https://github.com/cypress-io/cypress-example-docker-circle-workflows) | Run Multiple Cypress tests in parallel with [Circle Workflows](https://circleci.com/docs/2.0/workflows/) |
32-
| <Icon name="github" /> [Codeship Pro](https://github.com/cypress-io/cypress-example-docker-codeship) | Run Cypress tests in Docker on [Codeship Pro](https://codeship.com/) |
33-
| <Icon name="github" /> [demo-docker-cypress-included](https://github.com/bahmutov/demo-docker-cypress-included) | Demo running the complete Docker image `cypress/included` |
34-
| <Icon name="github" /> [cypress-example-docker-compose](https://github.com/cypress-io/cypress-example-docker-compose) | Run Cypress tests using docker-compose on [CircleCI](https://circleci.com/) |
35-
| <Icon name="github" /> [cypress-open-from-docker-compose](https://github.com/bahmutov/cypress-open-from-docker-compose) | Demo running application and Cypress tests using docker-compose |
36-
| <Icon name="github" /> [cypress-tests-apache-in-docker](https://github.com/bahmutov/cypress-tests-apache-in-docker) | Run local Cypress tests against Apache running inside a Docker container |
37-
| <Icon name="github" /> [cypress-example-docker-compose-included](https://github.com/cypress-io/cypress-example-docker-compose-included) | Cypress example with docker-compose and `cypress/included` image |
38-
| <Icon name="github" /> [cypress-desktop](https://github.com/piopi/cypress-desktop) | Run Cypress with a desktop environment and noVNC in Docker |
39-
40-
## See also
41-
42-
- ["Run Cypress with a single Docker command"](https://www.cypress.io/blog/2019/05/02/run-cypress-with-a-single-docker-command/)
21+
firefox, edge and cypress. It's used to create the above docker images and can
22+
be used by you to create a custom docker image with versions of your choice.

‎docs/faq/questions/cloud-faq.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,22 @@ Cloud.
5656
A [user](/guides/cloud/users) is anyone with a login to Cypress Cloud who has
5757
been invited to see and review the test results of your organization.
5858

59+
## <Icon name="angle-right" /> What if I can't access my Cypress Cloud account?
60+
61+
1. If you haven't signed up, see the
62+
[Sign Up with an Invitation](/guides/cloud/users#Sign-Up-with-an-Invitation)
63+
instructions.
64+
65+
2. Try resetting your password. If you never received the email, try the
66+
following:
67+
68+
- Try signing in with Google or GitHub
69+
- Check the trash and spam folder
70+
- Verify it's the correct email address
71+
72+
**If the troubleshooting tips above did not resolve the issue or involves SSO,
73+
reach out to [support](mailto:[email protected]).**
74+
5975
## <Icon name="angle-right" /> What is the difference between public and private projects?
6076

6177
**A public project** means that anyone can see the recorded runs for it. It's

‎docs/guides/cloud/getting-started.mdx

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
title: Getting Started
3+
sidebar_position: 20
4+
---
5+
6+
:::info
7+
8+
## <Icon name="graduation-cap" /> What you'll learn
9+
10+
- How to set up your project to record in Cypress Cloud
11+
- How to record and view your first run with your record key
12+
13+
:::
14+
15+
When you configure the open source Cypress app to record tests to Cypress Cloud,
16+
you'll see data from your project's latest recorded runs.
17+
18+
You typically want to record when running tests in
19+
[Continuous Integration](/guides/continuous-integration/introduction), but you
20+
can also record your tests when running locally.
21+
22+
:::tip
23+
24+
&#8239<Icon name="check-circle" color="green" /> Make sure to
25+
[install](/guides/getting-started/installing-cypress) and
26+
[open](/guides/getting-started/opening-the-app) the Cypress app to get started
27+
recording!
28+
29+
:::
30+
31+
## Setup
32+
33+
### Set up a project to record
34+
35+
1. Click on the **Runs** tab of your project within
36+
[Cypress](/guides/core-concepts/cypress-app).
37+
2. Click **Connect to Cypress Cloud**.
38+
3. You will need to log in to record your tests, so you'll be prompted to log in
39+
to Cypress Cloud here if you haven't already done so.
40+
<DocsImage
41+
src="/img/guides/cloud/projects/setup-a-project-1.jpg"
42+
alt="Connect to Cloud"
43+
/>
44+
4. Choose who owns the project. You can personally own it or select an
45+
organization you're a member of. If you don't have any organizations, click
46+
**Manage organizations**. Organizations work just like they do in GitHub and
47+
enable you to separate your personal and work projects.
48+
[Read more about organizations](/guides/cloud/organizations).
49+
<DocsImage
50+
src="/img/guides/cloud/projects/setup-a-project-2.jpg"
51+
alt="Choose an Organization"
52+
/>
53+
5. If you don't have any existing projects, you'll have the opportunity to
54+
create a new one here. If you have existing projects and want to create a new
55+
one, you can click **Create new** to make a new one.
56+
57+
- Fill in the name of your project (this is only for display purposes and can
58+
be changed later).
59+
- Choose whether this project is Public or Private.
60+
61+
See more about [Public-vs-Private project settings](projects#Public-vs-Private).
62+
63+
<DocsImage
64+
src="/img/guides/cloud/projects/setup-a-project-3.jpg"
65+
alt="Create a New Project"
66+
/>
67+
68+
6. Alternatively, if you've already created a project in Cypress Cloud, you can
69+
link your project by selecting it from the dropdown. Make sure to select a
70+
clean project that has not previously been linked to an existing project.
71+
<DocsImage
72+
src="/img/guides/cloud/projects/setup-a-project-4.jpg"
73+
alt="Choose a Project"
74+
/>
75+
7. Click **Setup Project**.
76+
8. Now you should see a view explaining how to record your first run with your
77+
record key.
78+
<DocsImage
79+
src="/img/guides/cloud/projects/setup-a-project-5.jpg"
80+
alt="Record Instructions"
81+
/>
82+
9. After setting up your project, Cypress inserts a unique
83+
[projectId](#Identification) into your Cypress configuration file. If you're
84+
using source control, we recommend that you check your configuration file,
85+
including the `projectId`, into source control.
86+
10. Within [Continuous Integration](/guides/continuous-integration/introduction)
87+
or from your local computer's terminal, pass the displayed
88+
[Record Key](#Identification) while running the
89+
[cypress run](/guides/guides/command-line#cypress-run) command.
90+
91+
Provide record key directly:
92+
93+
```shell
94+
cypress run --record --key <record key>
95+
```
96+
97+
Or set record key as environment variable:
98+
99+
```shell
100+
export CYPRESS_RECORD_KEY=<record key>
101+
```
102+
103+
```shell
104+
cypress run --record
105+
```
106+
107+
### View your recorded run
108+
109+
🎉 Your tests are now recording! As soon as tests finish running, you will see
110+
them in [Cypress Cloud](https://on.cypress.io/cloud) and in the _Runs_ tab of
111+
[Cypress](/guides/core-concepts/cypress-app).
112+
113+
<DocsImage
114+
src="/img/guides/cloud/projects/cloud-runs-list.jpg"
115+
alt="Cloud Screenshot"
116+
/>
117+
118+
<DocsImage
119+
src="/img/guides/cloud/projects/runs-list-in-desktop-gui.jpg"
120+
alt="Runs List"
121+
/>

‎docs/guides/cloud/projects.mdx

Lines changed: 1 addition & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,17 @@
11
---
22
title: Projects
3-
sidebar_position: 20
3+
sidebar_position: 30
44
---
55

66
:::info
77

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

10-
- How to set up your project to record in Cypress Cloud
1110
- `projectId` and Record Key identification and usage
1211
- Project settings and integrations
1312

1413
:::
1514

16-
When you configure the open source Cypress app to record tests to Cypress Cloud,
17-
you'll see data from your project's latest recorded runs.
18-
19-
You typically want to record when running tests in
20-
[Continuous Integration](/guides/continuous-integration/introduction), but you
21-
can also record your tests when running locally.
22-
23-
:::tip
24-
25-
&#8239<Icon name="check-circle" color="green" /> Make sure to
26-
[install](/guides/getting-started/installing-cypress) and
27-
[open](/guides/getting-started/opening-the-app) the Cypress app to get started
28-
recording!
29-
30-
:::
31-
32-
## Setup
33-
34-
### Set up a project to record
35-
36-
1. Click on the **Runs** tab of your project within
37-
[Cypress](/guides/core-concepts/cypress-app).
38-
2. Click **Connect to Cypress Cloud**.
39-
3. You will need to log in to record your tests, so you'll be prompted to log in
40-
to Cypress Cloud here if you haven't already done so.
41-
<DocsImage
42-
src="/img/guides/cloud/projects/setup-a-project-1.jpg"
43-
alt="Connect to Cloud"
44-
/>
45-
4. Choose who owns the project. You can personally own it or select an
46-
organization you're a member of. If you don't have any organizations, click
47-
**Manage organizations**. Organizations work just like they do in GitHub and
48-
enable you to separate your personal and work projects.
49-
[Read more about organizations](/guides/cloud/organizations).
50-
<DocsImage
51-
src="/img/guides/cloud/projects/setup-a-project-2.jpg"
52-
alt="Choose an Organization"
53-
/>
54-
5. If you don't have any existing projects, you'll have the opportunity to
55-
create a new one here. If you have existing projects and want to create a new
56-
one, you can click **Create new** to make a new one.
57-
58-
- Fill in the name of your project (this is only for display purposes and can
59-
be changed later).
60-
- Choose whether this project is Public or Private.
61-
62-
See more about [Public-vs-Private project settings](projects#Public-vs-Private).
63-
64-
<DocsImage
65-
src="/img/guides/cloud/projects/setup-a-project-3.jpg"
66-
alt="Create a New Project"
67-
/>
68-
69-
6. Alternatively, if you've already created a project in Cypress Cloud, you can
70-
link your project by selecting it from the dropdown. Make sure to select a
71-
clean project that has not previously been linked to an existing project.
72-
<DocsImage
73-
src="/img/guides/cloud/projects/setup-a-project-4.jpg"
74-
alt="Choose a Project"
75-
/>
76-
7. Click **Setup Project**.
77-
8. Now you should see a view explaining how to record your first run with your
78-
record key.
79-
<DocsImage
80-
src="/img/guides/cloud/projects/setup-a-project-5.jpg"
81-
alt="Record Instructions"
82-
/>
83-
9. After setting up your project, Cypress inserts a unique
84-
[projectId](#Identification) into your Cypress configuration file. If you're
85-
using source control, we recommend that you check your configuration file,
86-
including the `projectId`, into source control.
87-
10. Within [Continuous Integration](/guides/continuous-integration/introduction)
88-
or from your local computer's terminal pass the displayed
89-
[Record Key](#Identification) while running the
90-
[cypress run](/guides/guides/command-line#cypress-run) command.
91-
92-
Provide record key directly:
93-
94-
```shell
95-
cypress run --record --key <record key>
96-
```
97-
98-
Or set record key as environment variable
99-
100-
```shell
101-
export CYPRESS_RECORD_KEY=<record key>
102-
```
103-
104-
```shell
105-
cypress run --record
106-
```
107-
108-
🎉 Your tests are now recording! As soon as tests finish running, you will see
109-
them in [Cypress Cloud](https://on.cypress.io/cloud) and in the _Runs_ tab of
110-
[Cypress](/guides/core-concepts/cypress-app).
111-
112-
<DocsImage
113-
src="/img/guides/cloud/projects/cloud-runs-list.jpg"
114-
alt="Cloud Screenshot"
115-
/>
116-
117-
<DocsImage
118-
src="/img/guides/cloud/projects/runs-list-in-desktop-gui.jpg"
119-
alt="Runs List"
120-
/>
121-
12215
## Identification
12316

12417
Cypress uses your [projectId](#Project-ID) and [Record Key](#Record-key)

‎docs/guides/cloud/users.mdx

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,24 @@ A user is anyone who logs in to Cypress Cloud.
77

88
## Invite users
99

10-
You can invite users from [Cypress Cloud](https://on.cypress.io/cloud). Invited
11-
users will see all projects and tests run for the organization.
10+
Organization [owner or admin](#User-roles) roles can invite
11+
[Cypress Cloud](https://on.cypress.io/cloud) users. Those invited will see all
12+
projects and tests run for the organization.
13+
14+
_Note: only owners can give other users 'owner' access._
1215

1316
### Invite a user to an organization:
1417

15-
1. Go the [Organizations page](https://on.cypress.io/cloud/organizations) to
16-
select the organization you want to invite a user to.
17-
2. Click **Users**, then **Invite User**. _Note: you must have the
18-
[role of 'owner' or 'admin'](#User-roles) to invite users._
19-
3. Fill in their email and select their [role](#User-roles) then click **Invite
20-
User** _Note: only owners can give other users 'owner' access._
18+
1. Select the [organization](/guides/cloud/organizations) you want to invite a
19+
user to.
20+
2. Click **Users**, then **Invite User**.
21+
3. Fill in their email and select their [role](#User-roles), then click **Invite
22+
User**.
2123
4. The user will receive an invitation email with a link to accept the
2224
invitation.
2325

2426
<DocsImage
25-
src="/img/dashboard/invite-user-dialog.png"
27+
src="/img/guides/cloud/users/invite-user-dialog.jpg"
2628
alt="Invite User dialog"
2729
/>
2830

@@ -51,20 +53,24 @@ Cypress Cloud. From there, you will have the choice of authenitication type:
5153

5254
#### **Sign Up with Single Sign On (SSO) Authentication**
5355

54-
Refer to our
55-
[Enterprise SSO Guide](https://on.cypress.io/organizations#Slack-Integration)
56+
Refer to our [Enterprise SSO Guide](/guides/cloud/organizations#Enterprise-SSO).
57+
58+
#### Locked Out or Forgot Password
59+
60+
See
61+
[What if I can't access my Cypress Cloud account](/faq/questions/cloud-faq#What-if-I-cant-access-my-Cypress-Cloud-account).
5662

5763
## User roles
5864

5965
Users can be assigned roles that affect their access to certain features of
6066
[Cypress Cloud](https://on.cypress.io/cloud).
6167

62-
- **Member:** Can see the projects, runs, and keys.
68+
- **Member:** Can see projects, runs, and keys.
6369
- **Admin:** Can also invite, edit and delete users.
6470
- **Owner:** Can also transfer or delete projects. Can delete and edit the
6571
organization.
6672

67-
The permissions for each user role for Cypress Cloud.
73+
The permissions for each user role for Cypress Cloud:
6874

6975
| Permission | | | |
7076
| ----------------------------------------------- | ------------- | ------------ | ------------ |
@@ -83,7 +89,7 @@ The permissions for each user role for Cypress Cloud.
8389
| Edit 'member' in organization | | ✅ **Admin** | ✅ **Owner** |
8490
| Edit 'admin' in organization | | ✅ **Admin** | ✅ **Owner** |
8591
| Edit project name | | ✅ **Admin** | ✅ **Owner** |
86-
| Edit project status (private/public} | | ✅ **Admin** | ✅ **Owner** |
92+
| Edit project status (private/public) | | ✅ **Admin** | ✅ **Owner** |
8793
| Add or delete record keys | | ✅ **Admin** | ✅ **Owner** |
8894
| Set up GitHub Integration | | ✅ **Admin** | ✅ **Owner** |
8995
| Set up Slack Integration | | ✅ **Admin** | ✅ **Owner** |
@@ -112,14 +118,9 @@ deny them access.
112118

113119
## User updates
114120

115-
Changes can be made to both the primary email address associated with your
116-
Cypress Cloud account and the email address for billing notifications.
117-
118-
For updating the primary email address associated with Cypress Cloud, click your
119-
Profile picture in the upper left corner of the Organizations page. Select
120-
**Manage Profile**. Go to the **Email** field and select your preferred email
121-
address. _Note: The email list is limited to emails provided by login provider._
121+
To change a user email, an **Owner** or **Admin** can invite the new user/email
122+
address and delete the previous user/email address.
122123

123-
If you would like to update the billing email address, that can be done via the
124-
**Billing & Usage** page within [Cypress Cloud](https://on.cypress.io/cloud) or
125-
you contact them directly at [[email protected]](mailto:[email protected]).
124+
Update the billing email address via the **Billing & Usage** page within
125+
[Cypress Cloud](https://on.cypress.io/cloud) or by contacting
126+
[[email protected]](mailto:[email protected]) directly.

0 commit comments

Comments
 (0)