Skip to content

Commit 975387b

Browse files
isaacplmannFrozenPandaz
authored andcommitted
docs(core): remove nx connect flow from docs (#23204)
Recommend people log in to `nx.app` and connect their repository instead of running `nx connect` from the command line (cherry picked from commit 53693fd)
1 parent bf6963b commit 975387b

File tree

12 files changed

+282
-93
lines changed

12 files changed

+282
-93
lines changed

docs/nx-cloud/features/nx-enterprise-on-prem.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@ You get the **same level of security**, **dedicated support**, **SSO/SAML auth**
1717

1818
We also offer an uptime SLA guarantee of 99.98% for our Enterprise customers, SOC certificates on request, and we're happy to meet with your security teams if they have questions, or fill in security questionnaires. We also maintain a [Status Page here](https://status.nx.app/).
1919

20-
To start with this option, it's as easy as running
21-
22-
```shell
23-
npx nx connect
24-
```
20+
To start with this option, it's as easy as creating an account on [nx.app](https://cloud.nx.app) and connecting your repository.
2521

2622
### Single-tenant instance
2723

docs/nx-cloud/intro/ci-with-nx.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ Implementing an efficient CI setup for monorepos - while crucial - can be challe
1212

1313
## Try Nx Cloud Yourself!
1414

15-
```shell
16-
npx nx connect
17-
```
15+
[Create an account on Nx Cloud](https://cloud.nx.app) and connect your repository.
1816

1917
## Learn about Nx on CI
2018

docs/shared/angular-standalone-tutorial/angular-standalone.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,31 +1041,65 @@ When you are ready to add another application to the repo, you'll probably want
10411041

10421042
You can also go through the full [Angular monorepo tutorial](/getting-started/tutorials/angular-monorepo-tutorial)
10431043

1044-
## Setup CI for the Angular App
1044+
## Set Up CI for the Angular App
10451045

1046-
This tutorial walked you through how Nx can improve the developer experience for local development, but Nx can also make a big difference in CI. Without adequate tooling, CI times tend to grow exponentially with the size of the codebase. Nx helps reduce wasted time in CI with the [`affected` command](/ci/features/affected) and Nx Replay's [remote caching](/ci/features/remote-cache). Nx also [efficiently parallelizes tasks across machines](/ci/concepts/parallelization-distribution) with Nx Agents.
1046+
This tutorial walked you through how Nx can improve the local development experience, but the biggest difference Nx makes is in CI. As repositories get bigger, making sure that the CI is fast, reliable and maintainable can get very challenging. Nx provides a solution.
10471047

1048-
To set up Nx Cloud run:
1048+
- Nx reduces wasted time in CI with the [`affected` command](/ci/features/affected).
1049+
- Nx Replay's [remote caching](/ci/features/remote-cache) will reuse task artifacts from different CI executions making sure you will never run the same computation twice.
1050+
- Nx Agents [efficiently distribute tasks across machines](/ci/concepts/parallelization-distribution) ensuring constant CI time regardless of the repository size. The right number of machines is allocated for each PR to ensure good performance without wasting compute.
1051+
- Nx Atomizer [automatically splits](/ci/features/split-e2e-tasks) large e2e tests to distribute them across machines. Nx can also automatically [identify and rerun flaky e2e tests](/ci/features/flaky-tasks).
10491052

1050-
```shell
1051-
nx connect
1052-
```
1053-
1054-
And click the link provided. You'll need to follow the instructions on the website to sign up for your account.
1053+
### Generating a CI Workflow
10551054

1056-
Then you can set up your CI with the following command:
1055+
If you are starting a new project, you can use the following command to generate a CI workflow file.
10571056

10581057
```shell
1059-
nx generate ci-workflow --ci=github
1058+
npx nx generate ci-workflow --ci=github
10601059
```
10611060

10621061
{% callout type="note" title="Choose your CI provider" %}
10631062
You can choose `github`, `circleci`, `azure`, `bitbucket-pipelines`, or `gitlab` for the `ci` flag.
10641063
{% /callout %}
10651064

1066-
This will create a default CI configuration that sets up Nx Cloud to [use distributed task execution](/ci/features/distribute-task-execution). This automatically runs all tasks on separate machines in parallel wherever possible, without requiring you to manually coordinate copying the output from one machine to another.
1065+
This generator creates a `.github/workflows/ci.yml` file that contains a CI pipeline that will run the `lint`, `test`, `build` and `e2e` tasks for projects that are affected by any given PR.
1066+
1067+
The key line in the CI pipeline is:
1068+
1069+
```yml
1070+
- run: npx nx affected -t lint test build e2e-ci
1071+
```
1072+
1073+
### Connecting to Nx Cloud
1074+
1075+
Nx Cloud is a companion app for your CI system that provides remote caching, task distribution, e2e tests deflaking, better DX and more.
1076+
1077+
To connect to Nx Cloud:
1078+
1079+
- Commit and push your changes to GitHub
1080+
- Go to [https://cloud.nx.app](https://cloud.nx.app), create an account, and connect your repository
1081+
1082+
![Connect to your repository](/shared/tutorials/connect-to-repository.png)
1083+
1084+
`cloud.nx.app` will send a PR to your repository enabling Nx Cloud, after which caching, distribution and more will start working.
1085+
1086+
![Add an Nx Cloud access token to your repository dialog](/shared/tutorials/send-cloud-pr.png)
1087+
1088+
Once you merge that PR, you'll be able to see CI pipeline runs appearing in the Nx Cloud dashboard:
1089+
1090+
![CI Pipeline Executions](/shared/tutorials/ci-pipeline-executions.png)
1091+
1092+
### Enable a Distributed CI Pipeline
1093+
1094+
The current CI pipeline runs on a single machine and can only handle small workspaces. To transform your CI into a CI that runs on multiple machines and can handle workspaces of any size, uncomment the `npx nx-cloud start-ci-run` line in the `.github/workflows/ci.yml` file.
1095+
1096+
```yml
1097+
- run: npx nx-cloud start-ci-run --distribute-on="5 linux-medium-js" --stop-agents-after="e2e-ci"
1098+
```
1099+
1100+
![Run details](/shared/tutorials/gradle-run-details.png)
10671101

1068-
Check out one of these detailed tutorials on setting up CI with Nx:
1102+
For more information about how Nx can improve your CI pipeline, check out one of these detailed tutorials:
10691103

10701104
- [Circle CI with Nx](/ci/intro/tutorials/circle)
10711105
- [GitHub Actions with Nx](/ci/intro/tutorials/github-actions)

docs/shared/angular-tutorial/angular-monorepo.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1245,31 +1245,65 @@ If you have the ESLint plugin installed in your IDE you should immediately see a
12451245

12461246
Learn more about how to [enforce module boundaries](/features/enforce-module-boundaries).
12471247

1248-
## Setup CI for Your Angular Monorepo
1248+
## Set Up CI for Your Angular Monorepo
12491249

1250-
This tutorial walked you through how Nx can improve the developer experience for local development, but Nx can also make a big difference in CI. Without adequate tooling, CI times tend to grow exponentially with the size of the codebase. Nx helps reduce wasted time in CI with the [`affected` command](/ci/features/affected) and Nx Replay's [remote caching](/ci/features/remote-cache). Nx also [efficiently parallelizes tasks across machines](/ci/concepts/parallelization-distribution) with Nx Agents.
1250+
This tutorial walked you through how Nx can improve the local development experience, but the biggest difference Nx makes is in CI. As repositories get bigger, making sure that the CI is fast, reliable and maintainable can get very challenging. Nx provides a solution.
12511251

1252-
To set up Nx Cloud run:
1252+
- Nx reduces wasted time in CI with the [`affected` command](/ci/features/affected).
1253+
- Nx Replay's [remote caching](/ci/features/remote-cache) will reuse task artifacts from different CI executions making sure you will never run the same computation twice.
1254+
- Nx Agents [efficiently distribute tasks across machines](/ci/concepts/parallelization-distribution) ensuring constant CI time regardless of the repository size. The right number of machines is allocated for each PR to ensure good performance without wasting compute.
1255+
- Nx Atomizer [automatically splits](/ci/features/split-e2e-tasks) large e2e tests to distribute them across machines. Nx can also automatically [identify and rerun flaky e2e tests](/ci/features/flaky-tasks).
12531256

1254-
```shell
1255-
nx connect
1256-
```
1257-
1258-
And click the link provided. You'll need to follow the instructions on the website to sign up for your account.
1257+
### Generating a CI Workflow
12591258

1260-
Then you can set up your CI with the following command:
1259+
If you are starting a new project, you can use the following command to generate a CI workflow file.
12611260

12621261
```shell
1263-
nx generate ci-workflow --ci=github
1262+
npx nx generate ci-workflow --ci=github
12641263
```
12651264

12661265
{% callout type="note" title="Choose your CI provider" %}
12671266
You can choose `github`, `circleci`, `azure`, `bitbucket-pipelines`, or `gitlab` for the `ci` flag.
12681267
{% /callout %}
12691268

1270-
This will create a default CI configuration that sets up Nx Cloud to [use distributed task execution](/ci/features/distribute-task-execution). This automatically runs all tasks on separate machines in parallel wherever possible, without requiring you to manually coordinate copying the output from one machine to another.
1269+
This generator creates a `.github/workflows/ci.yml` file that contains a CI pipeline that will run the `lint`, `test`, `build` and `e2e` tasks for projects that are affected by any given PR.
1270+
1271+
The key line in the CI pipeline is:
1272+
1273+
```yml
1274+
- run: npx nx affected -t lint test build e2e-ci
1275+
```
1276+
1277+
### Connecting to Nx Cloud
1278+
1279+
Nx Cloud is a companion app for your CI system that provides remote caching, task distribution, e2e tests deflaking, better DX and more.
1280+
1281+
To connect to Nx Cloud:
1282+
1283+
- Commit and push your changes to GitHub
1284+
- Go to [https://cloud.nx.app](https://cloud.nx.app), create an account, and connect your repository
1285+
1286+
![Connect to your repository](/shared/tutorials/connect-to-repository.png)
1287+
1288+
`cloud.nx.app` will send a PR to your repository enabling Nx Cloud, after which caching, distribution and more will start working.
1289+
1290+
![Add an Nx Cloud access token to your repository dialog](/shared/tutorials/send-cloud-pr.png)
1291+
1292+
Once you merge that PR, you'll be able to see CI pipeline runs appearing in the Nx Cloud dashboard:
1293+
1294+
![CI Pipeline Executions](/shared/tutorials/ci-pipeline-executions.png)
1295+
1296+
### Enable a Distributed CI Pipeline
1297+
1298+
The current CI pipeline runs on a single machine and can only handle small workspaces. To transform your CI into a CI that runs on multiple machines and can handle workspaces of any size, uncomment the `npx nx-cloud start-ci-run` line in the `.github/workflows/ci.yml` file.
1299+
1300+
```yml
1301+
- run: npx nx-cloud start-ci-run --distribute-on="5 linux-medium-js" --stop-agents-after="e2e-ci"
1302+
```
1303+
1304+
![Run details](/shared/tutorials/gradle-run-details.png)
12711305

1272-
Check out one of these detailed tutorials on setting up CI with Nx:
1306+
For more information about how Nx can improve your CI pipeline, check out one of these detailed tutorials:
12731307

12741308
- [Circle CI with Nx](/ci/intro/tutorials/circle)
12751309
- [GitHub Actions with Nx](/ci/intro/tutorials/github-actions)

docs/shared/features/cache-task-results.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,7 @@ The cache is stored in `.nx/cache` by default. You can also [change where the ca
123123

124124
## Enable Remote Caching
125125

126-
You can enable remote caching (Nx Replay) by connecting to [Nx Cloud](/ci/features/remote-cache). To connect Nx to Nx Cloud run the following command:
127-
128-
```shell
129-
npx nx connect
130-
```
126+
You can enable remote caching (Nx Replay) by connecting to [Nx Cloud](/ci/features/remote-cache). To connect Nx to Nx Cloud, [create an account on cloud.nx.app](https://cloud.nx.app) and connect to your repository.
131127

132128
Learn more about [remote caching](/ci/features/remote-cache).
133129

docs/shared/guides/module-federation/faster-builds.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -298,11 +298,7 @@ our [community page](https://nx.dev/community) for links to our Discord and Twit
298298
## Remote computation caching with Nx Cloud
299299
300300
To use Module Federation well, we recommend that you enable [Nx Cloud](https://nx.app). If you haven't enabled it yet
301-
when using `create-nx-workspace`, you can do the following.
302-
303-
```shell
304-
nx connect
305-
```
301+
when using `create-nx-workspace`, create an account at [https://cloud.nx.app](https://cloud.nx.app) and connect to your repository.
306302
307303
With Nx Cloud enabled, a large set of builds can be skipped entirely when running the application locally (and in
308304
CI/CD). When you run builds through Nx + Nx Cloud, the artifacts are stored in the remote cache, so as long as the

docs/shared/migration/from-turborepo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,5 +153,5 @@ For each `turbo.json` configuration property, the equivalent Nx property is list
153153
| `--cpuprofile` | Use [`NX_PROFILE=profile.json`](/troubleshooting/performance-profiling). |
154154
| `--verbosity` | Use [`--verbose`](/nx-api/nx/documents/run-many#verbose) |
155155
| `turbo gen` | [Use `nx generate`](/nx-api/nx/documents/generate) |
156-
| `turbo login` | No need. [Use `nx connect`](/nx-api/nx/documents/connect-to-nx-cloud) once to set up Nx Cloud. |
157-
| `turbo link` | [Use `nx connect`](/nx-api/nx/documents/connect-to-nx-cloud) |
156+
| `turbo login` | No need. [Create an Nx Cloud account](/nx-api/nx/documents/connect-to-nx-cloud) once to set up Nx Cloud. |
157+
| `turbo link` | [Create an Nx Cloud account](/nx-api/nx/documents/connect-to-nx-cloud) |

docs/shared/react-standalone-tutorial/react-standalone.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -853,31 +853,65 @@ When you are ready to add another application to the repo, you'll probably want
853853

854854
You can also go through the full [React monorepo tutorial](/getting-started/tutorials/react-monorepo-tutorial)
855855

856-
## Setup CI for Your React App
856+
## Set Up CI for Your React App
857857

858-
This tutorial walked you through how Nx can improve the developer experience for local development, but Nx can also make a big difference in CI. Without adequate tooling, CI times tend to grow exponentially with the size of the codebase. Nx helps reduce wasted time in CI with the [`affected` command](/ci/features/affected) and Nx Replay's [remote caching](/ci/features/remote-cache). Nx also [efficiently parallelizes tasks across machines](/ci/concepts/parallelization-distribution) with Nx Agents.
858+
This tutorial walked you through how Nx can improve the local development experience, but the biggest difference Nx makes is in CI. As repositories get bigger, making sure that the CI is fast, reliable and maintainable can get very challenging. Nx provides a solution.
859859

860-
To set up Nx Cloud run:
860+
- Nx reduces wasted time in CI with the [`affected` command](/ci/features/affected).
861+
- Nx Replay's [remote caching](/ci/features/remote-cache) will reuse task artifacts from different CI executions making sure you will never run the same computation twice.
862+
- Nx Agents [efficiently distribute tasks across machines](/ci/concepts/parallelization-distribution) ensuring constant CI time regardless of the repository size. The right number of machines is allocated for each PR to ensure good performance without wasting compute.
863+
- Nx Atomizer [automatically splits](/ci/features/split-e2e-tasks) large e2e tests to distribute them across machines. Nx can also automatically [identify and rerun flaky e2e tests](/ci/features/flaky-tasks).
861864

862-
```shell
863-
nx connect
864-
```
865-
866-
And click the link provided. You'll need to follow the instructions on the website to sign up for your account.
865+
### Generating a CI Workflow
867866

868-
Then you can set up your CI with the following command:
867+
If you are starting a new project, you can use the following command to generate a CI workflow file.
869868

870869
```shell
871-
nx generate ci-workflow --ci=github
870+
npx nx generate ci-workflow --ci=github
872871
```
873872

874873
{% callout type="note" title="Choose your CI provider" %}
875874
You can choose `github`, `circleci`, `azure`, `bitbucket-pipelines`, or `gitlab` for the `ci` flag.
876875
{% /callout %}
877876

878-
This will create a default CI configuration that sets up Nx Cloud to [use distributed task execution](/ci/features/distribute-task-execution). This automatically runs all tasks on separate machines in parallel wherever possible, without requiring you to manually coordinate copying the output from one machine to another.
877+
This generator creates a `.github/workflows/ci.yml` file that contains a CI pipeline that will run the `lint`, `test`, `build` and `e2e` tasks for projects that are affected by any given PR.
878+
879+
The key line in the CI pipeline is:
880+
881+
```yml
882+
- run: npx nx affected -t lint test build e2e-ci
883+
```
884+
885+
### Connecting to Nx Cloud
886+
887+
Nx Cloud is a companion app for your CI system that provides remote caching, task distribution, e2e tests deflaking, better DX and more.
888+
889+
To connect to Nx Cloud:
890+
891+
- Commit and push your changes to GitHub
892+
- Go to [https://cloud.nx.app](https://cloud.nx.app), create an account, and connect your repository
893+
894+
![Connect to your repository](/shared/tutorials/connect-to-repository.png)
895+
896+
`cloud.nx.app` will send a PR to your repository enabling Nx Cloud, after which caching, distribution and more will start working.
897+
898+
![Add an Nx Cloud access token to your repository dialog](/shared/tutorials/send-cloud-pr.png)
899+
900+
Once you merge that PR, you'll be able to see CI pipeline runs appearing in the Nx Cloud dashboard:
901+
902+
![CI Pipeline Executions](/shared/tutorials/ci-pipeline-executions.png)
903+
904+
### Enable a Distributed CI Pipeline
905+
906+
The current CI pipeline runs on a single machine and can only handle small workspaces. To transform your CI into a CI that runs on multiple machines and can handle workspaces of any size, uncomment the `npx nx-cloud start-ci-run` line in the `.github/workflows/ci.yml` file.
907+
908+
```yml
909+
- run: npx nx-cloud start-ci-run --distribute-on="5 linux-medium-js" --stop-agents-after="e2e-ci"
910+
```
911+
912+
![Run details](/shared/tutorials/gradle-run-details.png)
879913

880-
Check out one of these detailed tutorials on setting up CI with Nx:
914+
For more information about how Nx can improve your CI pipeline, check out one of these detailed tutorials:
881915

882916
- [Circle CI with Nx](/ci/intro/tutorials/circle)
883917
- [GitHub Actions with Nx](/ci/intro/tutorials/github-actions)

0 commit comments

Comments
 (0)