Skip to content

Commit d658edb

Browse files
authored
Merge pull request #5139 from cypress-io/collected-updates
Collected updates
2 parents bf79e7f + 38d9a99 commit d658edb

File tree

15 files changed

+46
-51
lines changed

15 files changed

+46
-51
lines changed

docs/faq/questions/cloud-faq.mdx

+11-16
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ hide_table_of_contents: true
66
## <Icon name="angle-right" /> What is Cypress Cloud?
77

88
<DocsImage
9-
src="/img/dashboard/dashboard-runs-list.png"
9+
src="/img/guides/cloud/runs/run-details-page.png"
1010
alt="Cloud Screenshot"
11+
width="80%"
1112
/>
1213

1314
[Cypress Cloud](https://on.cypress.io/cloud) gives you access to tests you've
@@ -32,7 +33,7 @@ Please see our [Pricing Page](https://www.cypress.io/pricing) for more details.
3233
## <Icon name="angle-right" /> What counts as a test result?
3334

3435
Which [pricing tier](https://www.cypress.io/pricing) is best for you depends on
35-
the number of test you record each month in your organization.
36+
the number of tests you record each month in your organization.
3637

3738
Tests are recorded when [cypress run](/guides/guides/command-line#cypress-run)
3839
is called with the `--record` flag while supplying the record `--key`. This
@@ -57,9 +58,9 @@ been invited to see and review the test results of your organization.
5758
## <Icon name="angle-right" /> What is the difference between public and private projects?
5859

5960
**A public project** means that anyone can see the recorded runs for it. It's
60-
similar to how public projects on Github, Travis, or Circle are handled. Anyone
61-
who knows your `projectId` will be able to see the recorded runs, screenshots,
62-
and videos for public projects.
61+
similar to how public projects on Github, Travis, or CircleCI are handled.
62+
Anyone who knows your `projectId` will be able to see the recorded runs,
63+
screenshots, and videos for public projects.
6364

6465
**A private project** means that only [users](/guides/cloud/users) you
6566
explicitly invite to your [organization](/guides/cloud/organizations) can see
@@ -72,8 +73,8 @@ Cypress is **complementary** to your
7273
[CI provider](/guides/continuous-integration/introduction), and plays a
7374
completely different role.
7475

75-
It doesn't replace or change anything related to CI. You will run Cypress tests
76-
in your CI provider.
76+
It doesn't replace or change anything related to CI. You will still run Cypress
77+
tests in your CI provider.
7778

7879
The difference between [Cypress Cloud](/guides/cloud/introduction) and your CI
7980
provider is that your CI provider has no idea what is going on inside of the
@@ -160,8 +161,8 @@ Find a variable across your containers that is the same for all of them, but is
160161
different from run to run. For example it could be an environment variable
161162
called `CI_RUN_ID` that you set when creating the containers to run Cypress. You
162163
can pass this variable via CLI argument
163-
[`--ci-build-id`](/guides/guides/command-line#cypress-run-ci-build-id-lt-id-gt)when
164-
starting Cypress in each container:
164+
[`--ci-build-id`](/guides/guides/command-line#cypress-run-ci-build-id-lt-id-gt)
165+
when starting Cypress in each container:
165166

166167
```shell
167168
cypress run --record --parallel --ci-build-id $CI_RUN_ID
@@ -215,13 +216,7 @@ by:
215216
4. Review your organization's usage
216217
5. Scroll down and select **Upgrade** under your plan of choice
217218

218-
## <Icon name="angle-right" /> I'm working at a restrictive VPN. Which subdomains do I have to allow on
219-
220-
my VPN for Cypress Cloud to work properly?
221-
222-
To send the data and results of your tests to
223-
[Cypress Cloud](https://on.cypress.io/cloud-introduction), Cypress needs free
224-
access to some URLs.
219+
## <Icon name="angle-right" /> I'm working at a restrictive VPN. Which subdomains do I have to allow on my VPN for Cypress Cloud to work properly?
225220

226221
If you are running the tests from within a restrictive VPN you will need to
227222
allow some URLs so that Cypress can have effective communication with Cypress

docs/faq/questions/company-faq.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,4 @@ Yes! You can check our open positions and apply
2020
## <Icon name="angle-right" /> Why the name _Cypress_?
2121

2222
We believe that tests should always pass -- in other words, should always be
23-
green. A cypress is an evergreen tree. So, Cypress!
24-
25-
<Icon name="tree" color="green" />
23+
green. A cypress is an evergreen tree. So, Cypress! 🌲

docs/guides/cloud/jira-integration.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ workflow to enable:
2424

2525
## Installing the Jira integration
2626

27-
1. Visit **Integrations → Jira** in Cypress Cloud and click "Install Jira" {' '}
27+
1. Visit **Integrations → Jira** in Cypress Cloud and click "Install Jira"
2828
<DocsImage
2929
src="/img/dashboard/jira-integration/dashboard-jira-integration-install.png"
3030
alt="Cypress Cloud Integrations"
@@ -65,7 +65,7 @@ workflow to enable:
6565
alt="Cypress Cloud Select Organization for Jira Integration"
6666
/>
6767
1. The Jira Integration is complete. A list of projects permitted is provided on
68-
the Jira Integration page. {' '}
68+
the Jira Integration page.
6969
<DocsImage
7070
src="/img/dashboard/jira-integration/dashboard-jira-integration-completed.png"
7171
alt="Cypress Cloud Jira Integration"

docs/guides/cloud/organizations.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Organization to set up SSO.
201201
#### Enable SSO
202202

203203
1. Log in to Cypress Cloud and navigate to the **Integrations** page for your
204-
organization. {' '}
204+
organization.
205205
<DocsImage
206206
src="/img/dashboard/organizations/integrations-nenu-screenshot.png"
207207
alt="Enable SSO"
@@ -265,7 +265,7 @@ below, refer to
265265
Cypress Cloud needs the information provided here:
266266

267267
- Copy the Identity Provider Single sign-on URL to Cypress Cloud.
268-
- Download the certificate and upload that to Cypress Cloud. {' '}
268+
- Download the certificate and upload that to Cypress Cloud.
269269
<DocsImage
270270
src="/img/dashboard/organizations/okta-download-certificate-for-cypress-dashboard.png"
271271
alt="Download Certificate"

docs/guides/component-testing/angular/overview.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ npx cypress open
3232
<DocsImage
3333
src="/img/guides/component-testing/select-test-type.jpg"
3434
caption="Choose Component Testing"
35-
>
36-
{' '}
37-
</DocsImage>
35+
/>
3836

3937
The Cypress Launchpad will guide you through configuring your project.
4038

docs/guides/component-testing/react/api.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ it('mounts', () => {
117117
<td>strict</td>
118118
<td>boolean (optional)</td>
119119
<td>
120-
Render component in React{' '}
120+
Render component in React
121121
<a href="https://reactjs.org/docs/strict-mode.html">strict mode</a>
122122
It activates additional checks and warnings for child components.
123123
</td>
@@ -139,7 +139,7 @@ Type that the `mount` function yields
139139
<td>component</td>
140140
<td>React.ReactNode</td>
141141
<td>
142-
Render component in React{' '}
142+
Render component in React
143143
<a href="https://reactjs.org/docs/strict-mode.html">strict mode</a>
144144
It activates additional checks and warnings for child components.
145145
</td>

docs/guides/component-testing/react/overview.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,7 @@ npx cypress open
3838
<DocsImage
3939
src="/img/guides/component-testing/select-test-type.jpg"
4040
caption="Choose Component Testing"
41-
>
42-
{' '}
43-
</DocsImage>
41+
/>
4442

4543
The Cypress Launchpad will guide you through configuring your project.
4644

docs/guides/component-testing/svelte/overview.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,7 @@ npx cypress open
4242
<DocsImage
4343
src="/img/guides/component-testing/select-test-type.jpg"
4444
caption="Choose Component Testing"
45-
>
46-
{' '}
47-
</DocsImage>
45+
/>
4846

4947
The Cypress Launchpad will guide you through configuring your project.
5048

docs/guides/component-testing/vue/overview.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,7 @@ npx cypress open
3636
<DocsImage
3737
src="/img/guides/component-testing/select-test-type.jpg"
3838
caption="Choose Component Testing"
39-
>
40-
{' '}
41-
</DocsImage>
39+
/>
4240

4341
The Cypress Launchpad will guide you through configuring your project.
4442

docs/guides/guides/command-line.mdx

+9-7
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,28 @@ command's documentation.
3535
To run a command, you'll need to prefix each command in order to properly locate
3636
the cypress executable.
3737

38+
(requires [email protected] or greater)
39+
3840
```
39-
$(npm bin)/cypress run
41+
npx cypress run
4042
```
4143

42-
...or...
44+
...or by using Yarn...
4345

4446
```
45-
./node_modules/.bin/cypress run
47+
yarn cypress run
4648
```
4749

48-
...or... (requires [email protected] or greater)
50+
...or...
4951

5052
```
51-
npx cypress run
53+
$(npm bin)/cypress run
5254
```
5355

54-
...or by using Yarn...
56+
...or...
5557

5658
```
57-
yarn cypress run
59+
./node_modules/.bin/cypress run
5860
```
5961

6062
You may find it easier to add the cypress command to the `scripts` object in

docs/guides/overview/why-cypress.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ do that no other testing framework can:
120120
or videos of your entire test suite when run from the CLI. Record to
121121
[Cypress Cloud](/guides/cloud/introduction) to store them with your test
122122
results for zero-configuration debugging.
123-
- **Cross browser Testing:** Run tests within Firefox and Chrome-family browsers
123+
- **Cross Browser Testing:** Run tests within Firefox and Chrome-family browsers
124124
(including Edge and Electron) locally and
125125
[optimally in a Continuous Integration pipeline](/guides/guides/cross-browser-testing).
126126
- **Smart Orchestration:** Once you're set up to record to Cypress Cloud, easily

docs/guides/references/best-practices.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ If you're familiar with Cypress commands already, but find yourself using
290290
For working with either of these patterns, please read our
291291
[Variables and Aliases guide](/guides/core-concepts/variables-and-aliases).
292292

293-
## Visiting external sites
293+
## Visiting External Sites
294294

295295
:::danger
296296

@@ -447,7 +447,7 @@ email's functionality and visual style:
447447
environment variables. Some email services already provide
448448
[Cypress plugins](/plugins#Email) to access emails.
449449

450-
## Having tests rely on the state of previous tests
450+
## Having Tests Rely On The State Of Previous Tests
451451

452452
:::danger
453453

@@ -578,7 +578,7 @@ We're also paving the way to make it less complicated to write multiple tests
578578
against the "default" state of the form. That way each test stays lean but each
579579
can be run independently and pass.
580580

581-
## Creating "tiny" tests with a single assertion <E2EOnlyBadge />
581+
## Creating "Tiny" Tests With A Single Assertion <E2EOnlyBadge />
582582

583583
:::danger
584584

@@ -664,7 +664,7 @@ describe('my form', () => {
664664
})
665665
```
666666

667-
## Using `after` or `afterEach` hooks
667+
## Using `after` Or `afterEach` Hooks
668668

669669
:::danger
670670

@@ -1011,7 +1011,7 @@ Are you trying to run in CI?
10111011
We have
10121012
[examples showing you how to start and stop your web server](/guides/continuous-integration/introduction#Boot-your-server).
10131013

1014-
## Setting a global baseUrl
1014+
## Setting a Global `baseUrl`
10151015

10161016
:::danger
10171017

docs/guides/references/cypress-studio.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ For this test, we will add a new bank account. Our interactions are as follows:
280280
src="/img/guides/cypress-studio/add-test-form-complete.png"
281281
alt="Cypress Studio Add Test Complete Bank Account Form"
282282
/>
283-
4. Click the "Save" button {' '}
283+
4. Click the "Save" button
284284
<DocsImage
285285
src="/img/guides/cypress-studio/add-test-form-save.png"
286286
alt="Cypress Studio Add Test Save Bank Account"

src/css/markdown.scss

+8
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ div.markdown {
3333
}
3434
}
3535

36+
// add border bottom to code tags that are in a link
37+
a:has(> code) {
38+
border-bottom: 1px dotted var(--ifm-link-color);
39+
&:hover {
40+
border-bottom: 1px solid var(--ifm-link-color);
41+
}
42+
}
43+
3644
h2 {
3745
margin-bottom: 1.5rem;
3846
padding-bottom: 0.5rem;

0 commit comments

Comments
 (0)