Skip to content

Commit

Permalink
docs(core): update nx connect feature page (#26957)
Browse files Browse the repository at this point in the history
Fix the title of "Connect to Nx Cloud" to be consistent

Old inconsistent titles:
![Screenshot 2024-07-16 at 10 09
47 AM](https://github.com/user-attachments/assets/8122aa79-edaf-46a9-b278-a3c4e2fa214d)

Also adds a sentence explaining the `nx-cloud record` line in step 3,
since that isn't obvious what it is doing.
  • Loading branch information
isaacplmann committed Jul 17, 2024
1 parent 3a40d37 commit a0baab0
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 21 deletions.
14 changes: 7 additions & 7 deletions docs/generated/manifests/ci.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@
"tags": []
},
{
"id": "connect-to-cloud",
"name": "Connect Nx Cloud",
"id": "connect-to-nx-cloud",
"name": "Connect to Nx Cloud",
"description": "",
"mediaImage": "",
"file": "nx-cloud/intro/connect-to-cloud",
"itemList": [],
"isExternal": false,
"path": "/ci/intro/connect-to-cloud",
"path": "/ci/intro/connect-to-nx-cloud",
"tags": []
},
{
Expand Down Expand Up @@ -100,15 +100,15 @@
"path": "/ci/intro/why-nx-cloud",
"tags": []
},
"/ci/intro/connect-to-cloud": {
"id": "connect-to-cloud",
"name": "Connect Nx Cloud",
"/ci/intro/connect-to-nx-cloud": {
"id": "connect-to-nx-cloud",
"name": "Connect to Nx Cloud",
"description": "",
"mediaImage": "",
"file": "nx-cloud/intro/connect-to-cloud",
"itemList": [],
"isExternal": false,
"path": "/ci/intro/connect-to-cloud",
"path": "/ci/intro/connect-to-nx-cloud",
"tags": []
},
"/ci/intro/tutorials": {
Expand Down
12 changes: 6 additions & 6 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -5170,9 +5170,9 @@
"disableCollapsible": false
},
{
"name": "Connect Nx Cloud",
"path": "/ci/intro/connect-to-cloud",
"id": "connect-to-cloud",
"name": "Connect to Nx Cloud",
"path": "/ci/intro/connect-to-nx-cloud",
"id": "connect-to-nx-cloud",
"isExternal": false,
"children": [],
"disableCollapsible": false
Expand Down Expand Up @@ -5222,9 +5222,9 @@
"disableCollapsible": false
},
{
"name": "Connect Nx Cloud",
"path": "/ci/intro/connect-to-cloud",
"id": "connect-to-cloud",
"name": "Connect to Nx Cloud",
"path": "/ci/intro/connect-to-nx-cloud",
"id": "connect-to-nx-cloud",
"isExternal": false,
"children": [],
"disableCollapsible": false
Expand Down
4 changes: 2 additions & 2 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -1570,8 +1570,8 @@
"file": "nx-cloud/intro/why-nx-cloud"
},
{
"name": "Connect Nx Cloud",
"id": "connect-to-cloud",
"name": "Connect to Nx Cloud",
"id": "connect-to-nx-cloud",
"file": "nx-cloud/intro/connect-to-cloud"
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/nx-cloud/intro/connect-to-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ Or, check out our [recipes for the various CI providers](/ci/recipes/set-up).
**Step 3: Run your Nx commands as usual**

```yml
- run: npx nx-cloud record -- nx format:check
- run: npx nx-cloud record -- node tools/custom-script.js
- run: npx nx affected -t lint test build
- run: npx nx affected -t e2e-ci --parallel 1
```
All these commands are automatically picked up by Nx Cloud, split up into smaller tasks and distributed across the specified number of machines.
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).

**Step 4: All results are played back automatically**

Expand Down
2 changes: 1 addition & 1 deletion docs/nx-cloud/intro/why-nx-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Read more about individual features of Nx Cloud in the [features section](/ci/fe

## Integrate Nx Cloud into my CI setup

Ready to experience fast CI? Read the [connect to Nx Cloud](/ci/intro/connect-to-cloud) page for more details.
Ready to experience fast CI? Read the [connect to Nx Cloud](/ci/intro/connect-to-nx-cloud) page for more details.

## Learn more

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/features/remote-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this diagram, Teika runs the build once on his machine, then CI, Kimiko and J

## Setting Up Nx Cloud

To use **Nx Replay** you need to connect your workspace to Nx Cloud. See the [connect to Nx Cloud recipe](/ci/intro/connect-to-cloud).
To use **Nx Replay** you need to connect your workspace to Nx Cloud. See the [connect to Nx Cloud recipe](/ci/intro/connect-to-nx-cloud).

## See Remote Caching in Action

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/reference/sitemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@
- [Intro](/ci/intro)
- [CI with Nx](/ci/intro/ci-with-nx)
- [Why Nx Cloud?](/ci/intro/why-nx-cloud)
- [Connect Nx Cloud](/ci/intro/connect-to-cloud)
- [Connect to Nx Cloud](/ci/intro/connect-to-nx-cloud)
- [Tutorials](/ci/intro/tutorials)
- [Circle CI with Nx](/ci/intro/tutorials/circle)
- [GitHub Actions with Nx](/ci/intro/tutorials/github-actions)
Expand Down
3 changes: 2 additions & 1 deletion nx-dev/nx-dev/redirect-rules.js
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,8 @@ const nxCloudUrls = {
'/ci/concepts/parallelization-distribution',
'/nx-cloud/:path*': '/ci/:path*',
'/core-features/:path*': '/features/:path*',
'/ci/recipes/set-up/connect-to-cloud': '/ci/intro/connect-to-cloud',
'/ci/recipes/set-up/connect-to-cloud': '/ci/intro/connect-to-nx-cloud',
'/ci/intro/connect-to-cloud': '/ci/intro/connect-to-nx-cloud',
};

/**
Expand Down

0 comments on commit a0baab0

Please sign in to comment.