Skip to content

Commit e74db49

Browse files
committed
docs(nx-cloud): update CTA and connect instructions
1 parent 04af849 commit e74db49

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

docs/nx-cloud/intro/connect-to-cloud.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,42 @@ Nx Cloud directly integrates with your existing CI setup.
44

55
![Nx Cloud Overview](/shared/images/nx-cloud/nx-cloud-overview.webp)
66

7-
In a nutshell, here's how this works:
7+
Here's how you get set up.
88

9-
**Step 1: Connect your workspace to Nx Cloud**
9+
## Step 1: Connect your workspace to Nx Cloud
1010

11-
This can be done by signing up on [nx.app](https://nx.app) and then connecting to your git repository.
11+
To connect your workspace, **push it to GitHub** (or your respective source control provider) and then run:
1212

1313
```shell
1414
npx nx connect
1515
```
1616

17-
**Step 2: Your CI script triggers Nx Cloud**
17+
## Step 2: Configure your CI script
18+
19+
If you have CI set up already, configure [distribution with Nx Agents](/ci/features/distribute-task-execution) as follows:
1820

1921
```yml
2022
- name: Start CI run
2123
run: 'npx nx-cloud start-ci-run --distribute-on="8 linux-medium-js"'
2224
```
2325
24-
Let us generate the workflow file for you, if you don't already have one.
26+
Alternatively you can generate the CI configuration using:
2527
2628
```shell
2729
npx nx g ci-workflow
2830
```
2931

3032
Or, check out our [recipes for the various CI providers](/ci/recipes/set-up).
3133

32-
**Step 3: Run your Nx commands as usual**
34+
## Step 3: Run your Nx commands as usual
3335

3436
```yml
3537
- run: npx nx-cloud record -- node tools/custom-script.js
36-
- run: npx nx affected -t lint test build
37-
- run: npx nx affected -t e2e-ci --parallel 1
38+
- run: npx nx affected -t lint test build e2e-ci
3839
```
3940
4041
All these commands are automatically picked up by Nx Cloud, split up into smaller tasks and distributed across the specified number of machines. Nx Cloud works with Nx tasks automatically, or you can [record non-Nx commands with `nx-cloud record`](/ci/recipes/other/record-commands).
4142

42-
**Step 4: All results are played back automatically**
43+
## Step 4: All results are played back automatically
4344

4445
Nx Cloud automatically plays back all results to your CI system, as if distribution never happened. You can continue doing post-processing on the results, like uploading test reports, deploying artifacts etc.

nx-dev/nx-dev/app/nx-cloud/page.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,10 @@ export default function NxCloudPage(): JSX.Element {
6161
<Statistics />
6262
</div>
6363
<div className="mt-32 lg:mt-56">
64-
<CallToAction />
64+
<CallToAction
65+
mainActionTitle="Learn more about Nx Cloud on CI"
66+
mainActionLink="/ci/intro/ci-with-nx"
67+
/>
6568
</div>
6669
</DefaultLayout>
6770
);

0 commit comments

Comments
 (0)