diff --git a/docs/angular/getting-started/getting-started.md b/docs/angular/getting-started/getting-started.md index b3acca00b6..f4e4d69874 100644 --- a/docs/angular/getting-started/getting-started.md +++ b/docs/angular/getting-started/getting-started.md @@ -24,5 +24,5 @@ npx create-nx-workspace --preset=angular - [Nx CLI](/{{framework}}/getting-started/cli-overview) - [Configuration Files](/{{framework}}/getting-started/configuration) -- [Computation Caching](/{{framework}}/workspace/computation-caching) -- [Rebuilding What is Affected](/{{framework}}/guides/ci/monorepo-affected) +- [Computation Caching](/{{framework}}/core-concepts/computation-caching) +- [Rebuilding What is Affected](/{{framework}}/core-concepts/affected) diff --git a/docs/angular/guides/cli-overview.md b/docs/angular/guides/cli-overview.md index 8577cd9ebb..015290331e 100644 --- a/docs/angular/guides/cli-overview.md +++ b/docs/angular/guides/cli-overview.md @@ -126,7 +126,7 @@ A target can have multiple configuration. In the example above the serve target ```bash nx run todos:serve # default configuration -nx run todos:serve:production # producttion configuration +nx run todos:serve:production # production configuration ``` Because running target is such a common operation, you can also use the following syntax to do it: @@ -259,7 +259,7 @@ For example: 2. `workspaceRoot/apps/my-app/.env` contains `AUTH_URL=https://prod-url.com/auth` 3. Nx will first load the variables from `apps/my-app/.local.env` into the process. When it tries to load the variables from `apps/my-app/.env`, it will notice that `AUTH_URL` already exists, so it will ignore it. -We recommend nesting your **app** specific `env` files in `apps/your-app`, and creating workspace/root level `env` files for workspace-specific settings (like the [Nx Cloud token](https://nx.dev/angular/workspace/computation-caching#nx-cloud-and-distributed-computation-memoization)). +We recommend nesting your **app** specific `env` files in `apps/your-app`, and creating workspace/root level `env` files for workspace-specific settings (like the [Nx Cloud token](https://nx.dev/angular/core-concepts/computation-caching#nx-cloud-and-distributed-computation-memoization)). ### Pointing to custom env files diff --git a/docs/angular/migration/migration-angular.md b/docs/angular/migration/migration-angular.md index 9265c83c3b..25a32a6cc0 100644 --- a/docs/angular/migration/migration-angular.md +++ b/docs/angular/migration/migration-angular.md @@ -92,8 +92,8 @@ Learn more about the advantages of Nx in the following guides: - [Using Cypress for e2e tests](/angular/plugins/cypress/overview) - [Using Jest for unit tests](/angular/plugins/jest/overview) -- [Computation Caching](/angular/workspace/computation-caching) -- [Rebuilding and Retesting What is Affected](/angular/guides/ci/monorepo-affected) +- [Computation Caching](/angular/core-concepts/computation-caching) +- [Rebuilding and Retesting What is Affected](/angular/core-concepts/affected) ## Transitioning Manually @@ -376,4 +376,4 @@ Learn more about the advantages of Nx in the following guides: [Using Cypress for e2e tests](/angular/plugins/cypress/overview) \ [Using Jest for unit tests](/angular/plugins/jest/overview) \ -[Rebuilding and Retesting What is Affected](/angular/guides/ci/monorepo-affected) +[Rebuilding and Retesting What is Affected](/angular/core-concepts/affected) diff --git a/docs/angular/tutorial/10-computation-caching.md b/docs/angular/tutorial/10-computation-caching.md index 370220478c..4bae5fc97b 100644 --- a/docs/angular/tutorial/10-computation-caching.md +++ b/docs/angular/tutorial/10-computation-caching.md @@ -59,7 +59,7 @@ Based on the state of the source code and the environment, Nx was able to figure Nx read the output from cache instead of running the command for 1 out of 2 projects. ``` -Nx built `api` and retrieved `todos` from its computation cache. Read more about the cache here [here](/{{framework}}/workspace/computation-caching). +Nx built `api` and retrieved `todos` from its computation cache. Read more about the cache here [here](/{{framework}}/core-concepts/computation-caching). ## --with-deps diff --git a/docs/angular/tutorial/12-summary.md b/docs/angular/tutorial/12-summary.md index d7908314be..a51d60cb1c 100644 --- a/docs/angular/tutorial/12-summary.md +++ b/docs/angular/tutorial/12-summary.md @@ -14,5 +14,5 @@ In this tutorial you: **Dive Deep:** - [Nx CLI](/{{framework}}/getting-started/cli-overview) -- [Computation Caching](/{{framework}}/workspace/computation-caching) -- [Rebuilding What is Affected](/{{framework}}/guides/ci/monorepo-affected) +- [Computation Caching](/{{framework}}/core-concepts/computation-caching) +- [Rebuilding What is Affected](/{{framework}}/core-concepts/affected) diff --git a/docs/map.json b/docs/map.json index 54924b35dc..dbcc3b166c 100644 --- a/docs/map.json +++ b/docs/map.json @@ -32,10 +32,10 @@ "file": "shared/console" }, { - "name": "File Structure", - "searchResultsName": "File Structure", - "id": "file-structure", - "file": "shared/file-structure" + "name": "Folder Structure", + "searchResultsName": "Folder Structure", + "id": "folder-structure", + "file": "shared/folder-structure" }, { "name": "Configuration", @@ -98,6 +98,37 @@ } ] }, + { + "name": "Core Concepts", + "id": "core-concepts", + "itemList": [ + { + "name": "Computation Caching", + "id": "computation-caching", + "file": "shared/computation-caching" + }, + { + "name": "Rebuild Only What is Affected", + "id": "affected", + "file": "shared/affected" + }, + { + "name": "Why Monorepos", + "id": "why-monorepos", + "file": "shared/guides/why-monorepos" + }, + { + "name": "Updating Nx", + "id": "updating-nx", + "file": "angular/guides/update" + }, + { + "name": "Nx Devkit", + "id": "nx-devkit", + "file": "shared/devkit" + } + ] + }, { "name": "Migration", "id": "migration", @@ -925,11 +956,6 @@ } ] }, - { - "name": "Computation Caching", - "id": "computation-caching", - "file": "shared/computation-caching" - }, { "name": "Generators", "id": "generators", @@ -997,11 +1023,6 @@ "name": "CI", "id": "ci", "itemList": [ - { - "name": "Rebuild Only What is Affected", - "id": "monorepo-affected", - "file": "shared/monorepo-affected" - }, { "name": "Distributed CI: Overview", "id": "distributed-builds", @@ -1071,30 +1092,15 @@ "id": "browser-support", "file": "shared/guides/browser-support" }, - { - "name": "Updating Nx", - "id": "updating-nx", - "file": "angular/guides/update" - }, { "name": "Running custom commands", "id": "running-custom-commands", "file": "angular/guides/running-custom-commands" }, - { - "name": "Nx Devkit", - "id": "nx-devkit", - "file": "shared/devkit" - }, { "name": "Nx Devkit and Angular Devkit", "id": "nx-devkit-angular-devkit", "file": "angular/guides/nx-devkit-angular-devkit" - }, - { - "name": "Why Monorepos", - "id": "why-monorepos", - "file": "shared/guides/why-monorepos" } ] }, @@ -1149,10 +1155,10 @@ "file": "shared/console" }, { - "name": "File Structure", - "searchResultsName": "File Structure", - "id": "file-structure", - "file": "shared/file-structure" + "name": "Folder Structure", + "searchResultsName": "Folder Structure", + "id": "folder-structure", + "file": "shared/folder-structure" }, { "name": "Configuration", @@ -1215,6 +1221,37 @@ } ] }, + { + "name": "Core Concepts", + "id": "core-concepts", + "itemList": [ + { + "name": "Computation Caching", + "id": "computation-caching", + "file": "shared/computation-caching" + }, + { + "name": "Rebuild Only What is Affected", + "id": "affected", + "file": "shared/affected" + }, + { + "name": "Why Monorepos", + "id": "why-monorepos", + "file": "shared/guides/why-monorepos" + }, + { + "name": "Updating Nx", + "id": "updating-nx", + "file": "shared/update" + }, + { + "name": "Nx Devkit", + "id": "nx-devkit", + "file": "shared/devkit" + } + ] + }, { "name": "Migration", "id": "migration", @@ -2038,11 +2075,6 @@ } ] }, - { - "name": "Computation Caching", - "id": "computation-caching", - "file": "shared/computation-caching" - }, { "name": "Generators", "id": "generators", @@ -2094,11 +2126,6 @@ "file": "shared/workspace/structure/dependency-graph" } ] - }, - { - "name": "Updating Nx", - "id": "update", - "file": "shared/update" } ] }, @@ -2110,11 +2137,6 @@ "name": "CI", "id": "ci", "itemList": [ - { - "name": "Rebuild Only What is Affected", - "id": "monorepo-affected", - "file": "shared/monorepo-affected" - }, { "name": "Distributed CI: Overview", "id": "distributed-builds", @@ -2166,16 +2188,6 @@ "name": "Next.js projects with Nx", "id": "nextjs", "file": "react/guides/nextjs" - }, - { - "name": "Nx Devkit", - "id": "nx-devkit", - "file": "shared/devkit" - }, - { - "name": "Why Monorepos", - "id": "why-monorepos", - "file": "shared/guides/why-monorepos" } ] }, @@ -2230,10 +2242,10 @@ "file": "shared/console" }, { - "name": "File Structure", - "searchResultsName": "File Structure", - "id": "file-structure", - "file": "shared/file-structure" + "name": "Folder Structure", + "searchResultsName": "Folder Structure", + "id": "folder-structure", + "file": "shared/folder-structure" }, { "name": "Configuration", @@ -2280,6 +2292,37 @@ } ] }, + { + "name": "Core Concepts", + "id": "core-concepts", + "itemList": [ + { + "name": "Computation Caching", + "id": "computation-caching", + "file": "shared/computation-caching" + }, + { + "name": "Rebuild Only What is Affected", + "id": "affected", + "file": "shared/affected" + }, + { + "name": "Why Monorepos", + "id": "why-monorepos", + "file": "shared/guides/why-monorepos" + }, + { + "name": "Updating Nx", + "id": "updating-nx", + "file": "shared/update" + }, + { + "name": "Nx Devkit", + "id": "nx-devkit", + "file": "shared/devkit" + } + ] + }, { "name": "Migration", "id": "migration", @@ -3088,11 +3131,6 @@ } ] }, - { - "name": "Computation Caching", - "id": "computation-caching", - "file": "shared/computation-caching" - }, { "name": "Generators", "id": "generators", @@ -3144,11 +3182,6 @@ "file": "shared/workspace/structure/dependency-graph" } ] - }, - { - "name": "Updating Nx", - "id": "update", - "file": "shared/update" } ] }, @@ -3160,11 +3193,6 @@ "name": "CI", "id": "ci", "itemList": [ - { - "name": "Rebuild Only What is Affected", - "id": "monorepo-affected", - "file": "shared/monorepo-affected" - }, { "name": "Distributed CI: Overview", "id": "distributed-builds", @@ -3191,16 +3219,6 @@ "name": "Using Nx at Enterprises", "id": "monorepo-nx-enterprise", "file": "shared/monorepo-nx-enterprise" - }, - { - "name": "Nx Devkit", - "id": "nx-devkit", - "file": "shared/devkit" - }, - { - "name": "Why Monorepos", - "id": "why-monorepos", - "file": "shared/guides/why-monorepos" } ] } diff --git a/docs/node/getting-started/getting-started.md b/docs/node/getting-started/getting-started.md index e5622c4dd7..dbf3954bb6 100644 --- a/docs/node/getting-started/getting-started.md +++ b/docs/node/getting-started/getting-started.md @@ -20,5 +20,5 @@ npx create-nx-workspace --preset=express - [Nx CLI](/{{framework}}/getting-started/cli-overview) - [Configuration Files](/{{framework}}/getting-started/configuration) -- [Computation Caching](/{{framework}}/workspace/computation-caching) -- [Rebuilding What is Affected](/{{framework}}/guides/ci/monorepo-affected) +- [Computation Caching](/{{framework}}/core-concepts/computation-caching) +- [Rebuilding What is Affected](/{{framework}}/core-concepts/affected) diff --git a/docs/node/guides/cli-overview.md b/docs/node/guides/cli-overview.md index b207caed8d..89da92788a 100644 --- a/docs/node/guides/cli-overview.md +++ b/docs/node/guides/cli-overview.md @@ -63,11 +63,9 @@ You can preview the changes a generator makes by using the `--dry-run` option. I ## Running Tasks -The Nx CLI uses builders to perform tasks, such as building and bundling your application, running unit tests, or running E2E tests against a specific target, whether that be an application or workspace. +The Nx CLI uses executors to perform tasks, such as building and bundling your application, running unit tests, or running E2E tests against a specific target, whether that be an application or workspace. -A builder is a function that uses the Architect API to perform a complex process such as "build", "test", or "lint". - -You can configure the builders in `workspace.json`. +You can configure the executors in `workspace.json`. ```json { @@ -76,9 +74,9 @@ You can configure the builders in `workspace.json`. "root": "apps/todos/", "sourceRoot": "apps/todos/src", "projectType": "application", - "architect": { + "targets": { "serve": { - "builder": "@nrwl/web:dev-server", + "executor": "@nrwl/web:dev-server", "options": { "buildTarget": "todos:build", "proxyConfig": "apps/todos/proxy.conf.json" @@ -90,7 +88,7 @@ You can configure the builders in `workspace.json`. } }, "test": { - "builder": "@nrwl/jest:jest", + "executor": "@nrwl/jest:jest", "options": { "jestConfig": "apps/todos/jest.config.js", "tsConfig": "apps/todos/tsconfig.spec.json", @@ -103,7 +101,7 @@ You can configure the builders in `workspace.json`. } ``` -In the example above, the `todos` application has two targets: `serve` and `test`. The `serve` target uses the `@nrwl/web:dev-server` builder, and the `test` target uses `@nrwl/jest:jest`. Every target uses a builder which actually runs this target. So targets are analogous to typed npm scripts, and builders are analogous to typed shell scripts. +In the example above, the `todos` application has two targets: `serve` and `test`. The `serve` target uses the `@nrwl/web:dev-server` executor, and the `test` target uses `@nrwl/jest:jest`. Every target uses an executor which actually runs this target. So targets are analogous to typed npm scripts, and executors are analogous to typed shell scripts. You can run the target as follows: @@ -116,7 +114,7 @@ A target can have multiple configuration. In the example above the serve target ```bash nx run todos:serve # default configuration -nx run todos:serve:production # producttion configuration +nx run todos:serve:production # production configuration ``` Because running target is such a common operation, you can also use the following syntax to do it: @@ -127,7 +125,7 @@ nx serve todos --configuration=production nx serve todos --prod ``` -You can name your targets any way you want, define as many of them as you want, and use any builders you want to implement them. +You can name your targets any way you want, define as many of them as you want, and use any executors you want to implement them. **These are some common targets:** @@ -188,7 +186,7 @@ Run the same target for the projects that failed last time. nx run-many --target=build --all --only-failed ``` -Any flags you pass to `run-many` that aren't Nx specific will be passed down to the builder. +Any flags you pass to `run-many` that aren't Nx specific will be passed down to the executor. ```sh nx run-many --target=build --all --prod @@ -223,7 +221,7 @@ nx affected:lint nx affected:e2e ``` -Any flags you pass to `run-many` that aren't Nx specific will be passed down to the builder. +Any flags you pass to `run-many` that aren't Nx specific will be passed down to the executor. ```sh nx affected --target=build --prod diff --git a/docs/node/tutorial/08-summary.md b/docs/node/tutorial/08-summary.md index 237d779867..1c014b3619 100644 --- a/docs/node/tutorial/08-summary.md +++ b/docs/node/tutorial/08-summary.md @@ -14,5 +14,5 @@ In this tutorial you: **Dive Deep:** - [Nx CLI](/{{framework}}/getting-started/cli-overview) -- [Computation Caching](/{{framework}}/workspace/computation-caching) -- [Rebuilding What is Affected](/{{framework}}/guides/ci/monorepo-affected) +- [Computation Caching](/{{framework}}/core-concepts/computation-caching) +- [Rebuilding What is Affected](/{{framework}}/core-concepts/affected) diff --git a/docs/react/getting-started/getting-started.md b/docs/react/getting-started/getting-started.md index 49f4c02646..5d94dc04f4 100644 --- a/docs/react/getting-started/getting-started.md +++ b/docs/react/getting-started/getting-started.md @@ -24,5 +24,5 @@ npx create-nx-workspace --preset=react - [Nx CLI](/{{framework}}/getting-started/cli-overview) - [Configuration Files](/{{framework}}/getting-started/configuration) -- [Computation Caching](/{{framework}}/workspace/computation-caching) -- [Rebuilding What is Affected](/{{framework}}/guides/ci/monorepo-affected) +- [Computation Caching](/{{framework}}/core-concepts/computation-caching) +- [Rebuilding What is Affected](/{{framework}}/core-concepts/affected) diff --git a/docs/react/guides/cli-overview.md b/docs/react/guides/cli-overview.md index 17cb8b1f4b..5030c09120 100644 --- a/docs/react/guides/cli-overview.md +++ b/docs/react/guides/cli-overview.md @@ -63,11 +63,9 @@ You can preview the changes a generator makes by using the `--dry-run` option. I ## Running Tasks -The Nx CLI uses builders to perform tasks, such as building and bundling your application, running unit tests, or running E2E tests against a specific target, whether that be an application or workspace. +The Nx CLI uses executors to perform tasks, such as building and bundling your application, running unit tests, or running E2E tests against a specific target, whether that be an application or workspace. -A builder is a function that uses the Architect API to perform a complex process such as "build", "test", or "lint". - -You can configure the builders in `workspace.json`. +You can configure the executors in `workspace.json`. ```json { @@ -76,9 +74,9 @@ You can configure the builders in `workspace.json`. "root": "apps/todos/", "sourceRoot": "apps/todos/src", "projectType": "application", - "architect": { + "targets": { "serve": { - "builder": "@nrwl/web:dev-server", + "executor": "@nrwl/web:dev-server", "options": { "buildTarget": "todos:build", "proxyConfig": "apps/todos/proxy.conf.json" @@ -90,7 +88,7 @@ You can configure the builders in `workspace.json`. } }, "test": { - "builder": "@nrwl/jest:jest", + "executor": "@nrwl/jest:jest", "options": { "jestConfig": "apps/todos/jest.config.js", "tsConfig": "apps/todos/tsconfig.spec.json", @@ -103,7 +101,7 @@ You can configure the builders in `workspace.json`. } ``` -In the example above, the `todos` application has two targets: `serve` and `test`. The `serve` target uses the `@nrwl/web:dev-server` builder, and the `test` target uses `@nrwl/jest:jest`. Every target uses a builder which actually runs this target. So targets are analogous to typed npm scripts, and builders are analogous to typed shell scripts. +In the example above, the `todos` application has two targets: `serve` and `test`. The `serve` target uses the `@nrwl/web:dev-server` executor, and the `test` target uses `@nrwl/jest:jest`. Every target uses an executor which actually runs this target. So targets are analogous to typed npm scripts, and executors are analogous to typed shell scripts. You can run the target as follows: @@ -116,7 +114,7 @@ A target can have multiple configuration. In the example above the serve target ```bash nx run todos:serve # default configuration -nx run todos:serve:production # producttion configuration +nx run todos:serve:production # production configuration ``` Because running target is such a common operation, you can also use the following syntax to do it: @@ -127,7 +125,7 @@ nx serve todos --configuration=production nx serve todos --prod ``` -You can name your targets any way you want, define as many of them as you want, and use any builders you want to implement them. +You can name your targets any way you want, define as many of them as you want, and use any executors you want to implement them. **These are some common targets:** @@ -188,7 +186,7 @@ Run the same target for the projects that failed last time. nx run-many --target=build --all --only-failed ``` -Any flags you pass to `run-many` that aren't Nx specific will be passed down to the builder. +Any flags you pass to `run-many` that aren't Nx specific will be passed down to the executor. ```sh nx run-many --target=build --all --prod @@ -223,7 +221,7 @@ nx affected:lint nx affected:e2e ``` -Any flags you pass to `run-many` that aren't Nx specific will be passed down to the builder. +Any flags you pass to `run-many` that aren't Nx specific will be passed down to the executor. ```sh nx affected --target=build --prod diff --git a/docs/react/guides/environment-variables.md b/docs/react/guides/environment-variables.md index aa9997a750..4ca6c9fbda 100644 --- a/docs/react/guides/environment-variables.md +++ b/docs/react/guides/environment-variables.md @@ -56,7 +56,7 @@ For example: 2. `workspaceRoot/apps/my-app/.env` contains `AUTH_URL=https://prod-url.com/auth` 3. Nx will first load the variables from `apps/my-app/.local.env` into the process. When it tries to load the variables from `apps/my-app/.env`, it will notice that `AUTH_URL` already exists, so it will ignore it. -We recommend nesting your **app** specific `env` files in `apps/your-app`, and creating workspace/root level `env` files for workspace-specific settings (like the [Nx Cloud token](https://nx.dev/react/workspace/computation-caching#nx-cloud-and-distributed-computation-memoization)). +We recommend nesting your **app** specific `env` files in `apps/your-app`, and creating workspace/root level `env` files for workspace-specific settings (like the [Nx Cloud token](https://nx.dev/react/core-concepts/computation-caching#nx-cloud-and-distributed-computation-memoization)). ### Pointing to custom env files diff --git a/docs/react/tutorial/10-computation-caching.md b/docs/react/tutorial/10-computation-caching.md index 3bb4d23342..4b59d7189f 100644 --- a/docs/react/tutorial/10-computation-caching.md +++ b/docs/react/tutorial/10-computation-caching.md @@ -54,7 +54,7 @@ Based on the state of the source code and the environment, Nx was able to figure Nx read the output from cache instead of running the command for 1 out of 2 projects. ``` -Nx built `api` and retrieved `todos` from its computation cache. Read more about the cache [here](/{{framework}}/workspace/computation-caching). +Nx built `api` and retrieved `todos` from its computation cache. Read more about the cache [here](/{{framework}}/core-concepts/computation-caching). ## --with-deps diff --git a/docs/react/tutorial/12-summary.md b/docs/react/tutorial/12-summary.md index 7e213c5a2f..8bde42ace0 100644 --- a/docs/react/tutorial/12-summary.md +++ b/docs/react/tutorial/12-summary.md @@ -14,5 +14,5 @@ In this tutorial you: **Dive Deep:** - [Nx CLI](/{{framework}}/getting-started/cli-overview) -- [Computation Caching](/{{framework}}/workspace/computation-caching) -- [Rebuilding What is Affected](/{{framework}}/guides/ci/monorepo-affected) +- [Computation Caching](/{{framework}}/core-concepts/computation-caching) +- [Rebuilding What is Affected](/{{framework}}/core-concepts/affected) diff --git a/docs/shared/monorepo-affected.md b/docs/shared/affected.md similarity index 100% rename from docs/shared/monorepo-affected.md rename to docs/shared/affected.md diff --git a/docs/shared/file-structure.md b/docs/shared/folder-structure.md similarity index 99% rename from docs/shared/file-structure.md rename to docs/shared/folder-structure.md index 60ec044b85..b631eb1a8e 100644 --- a/docs/shared/file-structure.md +++ b/docs/shared/folder-structure.md @@ -1,4 +1,4 @@ -# Nx Workspace +# Folder Structure ## Files diff --git a/docs/shared/migration/overview.md b/docs/shared/migration/overview.md index bb2bf4b6cd..61ef004eb0 100644 --- a/docs/shared/migration/overview.md +++ b/docs/shared/migration/overview.md @@ -161,7 +161,7 @@ Your use-case may also be covered by one of our community plugins. Plugin author [Learn more about the `run-commands` builder](/{{framework}}/plugins/workspace/builders/run-commands) -[Learn more about caching](/{{framework}}/workspace/computation-caching) +[Learn more about caching](/{{framework}}/core-concepts/computation-caching) [Learn more about community plugins](/nx-community) diff --git a/docs/shared/nx-plugin.md b/docs/shared/nx-plugin.md index 6d9923df7d..e7cb0deb70 100644 --- a/docs/shared/nx-plugin.md +++ b/docs/shared/nx-plugin.md @@ -106,7 +106,7 @@ Full E2Es are supported (and recommended) and will run everything on the file sy ## Executor -The default executor is set up to just emit a console log. Some examples of what a executor can do are: +The default executor is set up to just emit a console log. Some examples of what an executor can do are: - Support different languages, (Java, Go, Python, C#) - Compile new UI framework components