miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): random improvements on core section of docs

Browse Source
This commit is contained in:
Juri 2023-08-01 17:09:33 +02:00 committed by Juri Strumpflohner
parent bda5165266
commit 054a371aab
16 changed files with 225 additions and 231 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/generated/manifests/menus.json
View File

@ -786,17 +786,9 @@
"disableCollapsible": false
},
{
"name": "Share Your Cache",
"path": "/core-features/share-your-cache",
"id": "share-your-cache",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Explore the Graph",
"path": "/core-features/explore-graph",
"id": "explore-graph",
"name": "Use Remote Caching",
"path": "/core-features/remote-cache",
"id": "remote-cache",
"isExternal": false,
"children": [],
"disableCollapsible": false
@ -810,9 +802,9 @@
"disableCollapsible": false
},
{
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors",
"id": "integrate-with-editors",
"name": "Explore the Graph",
"path": "/core-features/explore-graph",
"id": "explore-graph",
"isExternal": false,
"children": [],
"disableCollapsible": false
@ -833,6 +825,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors",
"id": "integrate-with-editors",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Plugin Features",
"path": "/core-features/plugin-features",
@ -878,17 +878,9 @@
"disableCollapsible": false
},
{
"name": "Share Your Cache",
"path": "/core-features/share-your-cache",
"id": "share-your-cache",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Explore the Graph",
"path": "/core-features/explore-graph",
"id": "explore-graph",
"name": "Use Remote Caching",
"path": "/core-features/remote-cache",
"id": "remote-cache",
"isExternal": false,
"children": [],
"disableCollapsible": false
@ -902,9 +894,9 @@
"disableCollapsible": false
},
{
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors",
"id": "integrate-with-editors",
"name": "Explore the Graph",
"path": "/core-features/explore-graph",
"id": "explore-graph",
"isExternal": false,
"children": [],
"disableCollapsible": false
@ -925,6 +917,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors",
"id": "integrate-with-editors",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Plugin Features",
"path": "/core-features/plugin-features",

112
docs/generated/manifests/nx.json
View File

@ -957,7 +957,7 @@
{
"id": "run-tasks",
"name": "Run Tasks",
"description": "",
"description": "Learn about the various ways you can use Nx to run tasks in your workspace.",
"file": "shared/core-features/run-tasks",
"itemList": [],
"isExternal": false,
@ -967,7 +967,7 @@
{
"id": "cache-task-results",
"name": "Cache Task Results",
"description": "",
"description": "Learn how to define cacheable tasks, how to fine-tune with inputs and outputs, where the cache is stored and much more.",
"file": "shared/core-features/cache-task-results",
"itemList": [],
"isExternal": false,
@ -975,29 +975,19 @@
"tags": ["cache-task-results"]
},
{
"id": "share-your-cache",
"name": "Share Your Cache",
"description": "",
"file": "shared/core-features/share-your-cache",
"id": "remote-cache",
"name": "Use Remote Caching",
"description": "Learn how to enable remote caching s.t. you don't just benefit locally from it but also in CI.",
"file": "shared/core-features/remote-cache",
"itemList": [],
"isExternal": false,
"path": "/core-features/share-your-cache",
"tags": ["share-your-cache"]
},
{
"id": "explore-graph",
"name": "Explore the Graph",
"description": "",
"file": "shared/core-features/explore-graph",
"itemList": [],
"isExternal": false,
"path": "/core-features/explore-graph",
"tags": ["explore-graph"]
"path": "/core-features/remote-cache",
"tags": ["remote-cache"]
},
{
"id": "distribute-task-execution",
"name": "Distribute Task Execution",
"description": "",
"description": "Learn how to efficiently distribute tasks across machines to take full advantage of parallelization. Nx Cloud has a built-in DTE mechanism which makes this a trivial task.",
"file": "shared/core-features/distribute-task-execution",
"itemList": [],
"isExternal": false,
@ -1005,19 +995,19 @@
"tags": ["distribute-task-execution"]
},
{
"id": "integrate-with-editors",
"name": "Integrate with Editors",
"description": "",
"file": "shared/core-features/integrate-with-editors",
"id": "explore-graph",
"name": "Explore the Graph",
"description": "Nx uses a graph behind the scenes to optimize your operations. You can also visualize and use the graph to better understand your workspace structure. Learn more in this guide.",
"file": "shared/core-features/explore-graph",
"itemList": [],
"isExternal": false,
"path": "/core-features/integrate-with-editors",
"tags": ["integrate-with-editors"]
"path": "/core-features/explore-graph",
"tags": ["explore-graph"]
},
{
"id": "automate-updating-dependencies",
"name": "Automate Updating Dependencies",
"description": "",
"description": "Learn how Nx provides automated update scripts to help you keep your workspace, tooling and framework dependencies up to date.",
"file": "shared/core-features/automate-updating-dependencies",
"itemList": [],
"isExternal": false,
@ -1027,13 +1017,23 @@
{
"id": "enforce-module-boundaries",
"name": "Enforce Module Boundaries",
"description": "",
"description": "Learn how to avoid dependency hell and scale a codebase by imposing constraints on your projects using the module boundary lint rule.",
"file": "shared/core-features/enforce-module-boundaries",
"itemList": [],
"isExternal": false,
"path": "/core-features/enforce-module-boundaries",
"tags": ["enforce-module-boundaries"]
},
{
"id": "integrate-with-editors",
"name": "Integrate with Editors",
"description": "Learn about Nx Console, an extension for VS Code and WebStorm.",
"file": "shared/core-features/integrate-with-editors",
"itemList": [],
"isExternal": false,
"path": "/core-features/integrate-with-editors",
"tags": ["integrate-with-editors"]
},
{
"id": "plugin-features",
"name": "Plugin Features",
@ -1073,7 +1073,7 @@
"/core-features/run-tasks": {
"id": "run-tasks",
"name": "Run Tasks",
"description": "",
"description": "Learn about the various ways you can use Nx to run tasks in your workspace.",
"file": "shared/core-features/run-tasks",
"itemList": [],
"isExternal": false,
@ -1083,57 +1083,47 @@
"/core-features/cache-task-results": {
"id": "cache-task-results",
"name": "Cache Task Results",
"description": "",
"description": "Learn how to define cacheable tasks, how to fine-tune with inputs and outputs, where the cache is stored and much more.",
"file": "shared/core-features/cache-task-results",
"itemList": [],
"isExternal": false,
"path": "/core-features/cache-task-results",
"tags": ["cache-task-results"]
},
"/core-features/share-your-cache": {
"id": "share-your-cache",
"name": "Share Your Cache",
"description": "",
"file": "shared/core-features/share-your-cache",
"/core-features/remote-cache": {
"id": "remote-cache",
"name": "Use Remote Caching",
"description": "Learn how to enable remote caching s.t. you don't just benefit locally from it but also in CI.",
"file": "shared/core-features/remote-cache",
"itemList": [],
"isExternal": false,
"path": "/core-features/share-your-cache",
"tags": ["share-your-cache"]
},
"/core-features/explore-graph": {
"id": "explore-graph",
"name": "Explore the Graph",
"description": "",
"file": "shared/core-features/explore-graph",
"itemList": [],
"isExternal": false,
"path": "/core-features/explore-graph",
"tags": ["explore-graph"]
"path": "/core-features/remote-cache",
"tags": ["remote-cache"]
},
"/core-features/distribute-task-execution": {
"id": "distribute-task-execution",
"name": "Distribute Task Execution",
"description": "",
"description": "Learn how to efficiently distribute tasks across machines to take full advantage of parallelization. Nx Cloud has a built-in DTE mechanism which makes this a trivial task.",
"file": "shared/core-features/distribute-task-execution",
"itemList": [],
"isExternal": false,
"path": "/core-features/distribute-task-execution",
"tags": ["distribute-task-execution"]
},
"/core-features/integrate-with-editors": {
"id": "integrate-with-editors",
"name": "Integrate with Editors",
"description": "",
"file": "shared/core-features/integrate-with-editors",
"/core-features/explore-graph": {
"id": "explore-graph",
"name": "Explore the Graph",
"description": "Nx uses a graph behind the scenes to optimize your operations. You can also visualize and use the graph to better understand your workspace structure. Learn more in this guide.",
"file": "shared/core-features/explore-graph",
"itemList": [],
"isExternal": false,
"path": "/core-features/integrate-with-editors",
"tags": ["integrate-with-editors"]
"path": "/core-features/explore-graph",
"tags": ["explore-graph"]
},
"/core-features/automate-updating-dependencies": {
"id": "automate-updating-dependencies",
"name": "Automate Updating Dependencies",
"description": "",
"description": "Learn how Nx provides automated update scripts to help you keep your workspace, tooling and framework dependencies up to date.",
"file": "shared/core-features/automate-updating-dependencies",
"itemList": [],
"isExternal": false,
@ -1143,13 +1133,23 @@
"/core-features/enforce-module-boundaries": {
"id": "enforce-module-boundaries",
"name": "Enforce Module Boundaries",
"description": "",
"description": "Learn how to avoid dependency hell and scale a codebase by imposing constraints on your projects using the module boundary lint rule.",
"file": "shared/core-features/enforce-module-boundaries",
"itemList": [],
"isExternal": false,
"path": "/core-features/enforce-module-boundaries",
"tags": ["enforce-module-boundaries"]
},
"/core-features/integrate-with-editors": {
"id": "integrate-with-editors",
"name": "Integrate with Editors",
"description": "Learn about Nx Console, an extension for VS Code and WebStorm.",
"file": "shared/core-features/integrate-with-editors",
"itemList": [],
"isExternal": false,
"path": "/core-features/integrate-with-editors",
"tags": ["integrate-with-editors"]
},
"/core-features/plugin-features": {
"id": "plugin-features",
"name": "Plugin Features",

178
docs/generated/manifests/tags.json
View File

@ -1,7 +1,7 @@
{
"run-tasks": [
{
"description": "",
"description": "Learn about the various ways you can use Nx to run tasks in your workspace.",
"file": "shared/core-features/run-tasks",
"id": "run-tasks",
"name": "Run Tasks",
@ -52,7 +52,7 @@
],
"cache-task-results": [
{
"description": "",
"description": "Learn how to define cacheable tasks, how to fine-tune with inputs and outputs, where the cache is stored and much more.",
"file": "shared/core-features/cache-task-results",
"id": "cache-task-results",
"name": "Cache Task Results",
@ -136,62 +136,18 @@
"path": "/packages/nx/documents/reset"
}
],
"share-your-cache": [
"remote-cache": [
{
"description": "",
"file": "shared/core-features/share-your-cache",
"id": "share-your-cache",
"name": "Share Your Cache",
"path": "/core-features/share-your-cache"
}
],
"explore-graph": [
{
"description": "",
"file": "shared/core-features/explore-graph",
"id": "explore-graph",
"name": "Explore the Graph",
"path": "/core-features/explore-graph"
},
{
"description": "",
"file": "shared/concepts/how-project-graph-is-built",
"id": "how-project-graph-is-built",
"name": "How the Project Graph is Built",
"path": "/concepts/more-concepts/how-project-graph-is-built"
},
{
"description": "",
"file": "shared/recipes/analyze-source-files",
"id": "analyze-source-files",
"name": "Disable Graph Links Created from Analyzing Source Files",
"path": "/recipes/tips-n-tricks/analyze-source-files"
},
{
"description": "",
"file": "shared/recipes/resolve-circular-dependencies",
"id": "resolve-circular-dependencies",
"name": "Resolve Circular Dependencies",
"path": "/recipes/troubleshooting/resolve-circular-dependencies"
},
{
"description": "",
"file": "shared/recipes/plugins/project-graph-plugins",
"id": "project-graph-plugins",
"name": "Modify the Project Graph",
"path": "/extending-nx/recipes/project-graph-plugins"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/generated/packages/nx/documents/dep-graph",
"id": "dep-graph",
"name": "graph",
"path": "/packages/nx/documents/dep-graph"
"description": "Learn how to enable remote caching s.t. you don't just benefit locally from it but also in CI.",
"file": "shared/core-features/remote-cache",
"id": "remote-cache",
"name": "Use Remote Caching",
"path": "/core-features/remote-cache"
}
],
"distribute-task-execution": [
{
"description": "",
"description": "Learn how to efficiently distribute tasks across machines to take full advantage of parallelization. Nx Cloud has a built-in DTE mechanism which makes this a trivial task.",
"file": "shared/core-features/distribute-task-execution",
"id": "distribute-task-execution",
"name": "Distribute Task Execution",
@ -233,60 +189,53 @@
"path": "/packages/nx/documents/connect-to-nx-cloud"
}
],
"integrate-with-editors": [
"explore-graph": [
{
"description": "",
"file": "shared/core-features/integrate-with-editors",
"id": "integrate-with-editors",
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors"
"description": "Nx uses a graph behind the scenes to optimize your operations. You can also visualize and use the graph to better understand your workspace structure. Learn more in this guide.",
"file": "shared/core-features/explore-graph",
"id": "explore-graph",
"name": "Explore the Graph",
"path": "/core-features/explore-graph"
},
{
"description": "",
"file": "shared/recipes/console-telemetry",
"id": "console-telemetry",
"name": "Telemetry",
"path": "/recipes/nx-console/console-telemetry"
"file": "shared/concepts/how-project-graph-is-built",
"id": "how-project-graph-is-built",
"name": "How the Project Graph is Built",
"path": "/concepts/more-concepts/how-project-graph-is-built"
},
{
"description": "",
"file": "shared/recipes/console-generate-command",
"id": "console-generate-command",
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command"
"file": "shared/recipes/analyze-source-files",
"id": "analyze-source-files",
"name": "Disable Graph Links Created from Analyzing Source Files",
"path": "/recipes/tips-n-tricks/analyze-source-files"
},
{
"description": "",
"file": "shared/recipes/console-run-command",
"id": "console-run-command",
"name": "Run Command",
"path": "/recipes/nx-console/console-run-command"
"file": "shared/recipes/resolve-circular-dependencies",
"id": "resolve-circular-dependencies",
"name": "Resolve Circular Dependencies",
"path": "/recipes/troubleshooting/resolve-circular-dependencies"
},
{
"description": "",
"file": "shared/recipes/console-add-dependency-command",
"id": "console-add-dependency-command",
"name": "Add Dependency Command",
"path": "/recipes/nx-console/console-add-dependency-command"
"file": "shared/recipes/plugins/project-graph-plugins",
"id": "project-graph-plugins",
"name": "Modify the Project Graph",
"path": "/extending-nx/recipes/project-graph-plugins"
},
{
"description": "",
"file": "shared/recipes/console-project-pane",
"id": "console-project-pane",
"name": "Project Pane",
"path": "/recipes/nx-console/console-project-pane"
},
{
"description": "",
"file": "shared/recipes/console-shortcuts",
"id": "console-shortcuts",
"name": "Keyboard Shortcuts",
"path": "/recipes/nx-console/console-shortcuts"
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/generated/packages/nx/documents/dep-graph",
"id": "dep-graph",
"name": "graph",
"path": "/packages/nx/documents/dep-graph"
}
],
"automate-updating-dependencies": [
{
"description": "",
"description": "Learn how Nx provides automated update scripts to help you keep your workspace, tooling and framework dependencies up to date.",
"file": "shared/core-features/automate-updating-dependencies",
"id": "automate-updating-dependencies",
"name": "Automate Updating Dependencies",
@ -309,7 +258,7 @@
],
"enforce-module-boundaries": [
{
"description": "",
"description": "Learn how to avoid dependency hell and scale a codebase by imposing constraints on your projects using the module boundary lint rule.",
"file": "shared/core-features/enforce-module-boundaries",
"id": "enforce-module-boundaries",
"name": "Enforce Module Boundaries",
@ -414,6 +363,57 @@
"path": "/packages/nx/documents/workspace-lint"
}
],
"integrate-with-editors": [
{
"description": "Learn about Nx Console, an extension for VS Code and WebStorm.",
"file": "shared/core-features/integrate-with-editors",
"id": "integrate-with-editors",
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors"
},
{
"description": "",
"file": "shared/recipes/console-telemetry",
"id": "console-telemetry",
"name": "Telemetry",
"path": "/recipes/nx-console/console-telemetry"
},
{
"description": "",
"file": "shared/recipes/console-generate-command",
"id": "console-generate-command",
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command"
},
{
"description": "",
"file": "shared/recipes/console-run-command",
"id": "console-run-command",
"name": "Run Command",
"path": "/recipes/nx-console/console-run-command"
},
{
"description": "",
"file": "shared/recipes/console-add-dependency-command",
"id": "console-add-dependency-command",
"name": "Add Dependency Command",
"path": "/recipes/nx-console/console-add-dependency-command"
},
{
"description": "",
"file": "shared/recipes/console-project-pane",
"id": "console-project-pane",
"name": "Project Pane",
"path": "/recipes/nx-console/console-project-pane"
},
{
"description": "",
"file": "shared/recipes/console-shortcuts",
"id": "console-shortcuts",
"name": "Keyboard Shortcuts",
"path": "/recipes/nx-console/console-shortcuts"
}
],
"use-task-executors": [
{
"description": "",

36
docs/map.json
View File

@ -271,52 +271,60 @@
"itemList": [
{
"name": "Run Tasks",
"description": "Learn about the various ways you can use Nx to run tasks in your workspace.",
"tags": ["run-tasks"],
"id": "run-tasks",
"file": "shared/core-features/run-tasks"
},
{
"name": "Cache Task Results",
"description": "Learn how to define cacheable tasks, how to fine-tune with inputs and outputs, where the cache is stored and much more.",
"id": "cache-task-results",
"tags": ["cache-task-results"],
"file": "shared/core-features/cache-task-results"
},
{
"name": "Share Your Cache",
"id": "share-your-cache",
"tags": ["share-your-cache"],
"file": "shared/core-features/share-your-cache"
},
{
"name": "Explore the Graph",
"id": "explore-graph",
"tags": ["explore-graph"],
"file": "shared/core-features/explore-graph"
"name": "Use Remote Caching",
"description": "Learn how to enable remote caching s.t. you don't just benefit locally from it but also in CI.",
"id": "remote-cache",
"tags": ["remote-cache"],
"file": "shared/core-features/remote-cache"
},
{
"name": "Distribute Task Execution",
"description": "Learn how to efficiently distribute tasks across machines to take full advantage of parallelization. Nx Cloud has a built-in DTE mechanism which makes this a trivial task.",
"id": "distribute-task-execution",
"tags": ["distribute-task-execution"],
"file": "shared/core-features/distribute-task-execution"
},
{
"name": "Integrate with Editors",
"id": "integrate-with-editors",
"tags": ["integrate-with-editors"],
"file": "shared/core-features/integrate-with-editors"
"name": "Explore the Graph",
"id": "explore-graph",
"description": "Nx uses a graph behind the scenes to optimize your operations. You can also visualize and use the graph to better understand your workspace structure. Learn more in this guide.",
"tags": ["explore-graph"],
"file": "shared/core-features/explore-graph"
},
{
"name": "Automate Updating Dependencies",
"description": "Learn how Nx provides automated update scripts to help you keep your workspace, tooling and framework dependencies up to date.",
"id": "automate-updating-dependencies",
"tags": ["automate-updating-dependencies"],
"file": "shared/core-features/automate-updating-dependencies"
},
{
"name": "Enforce Module Boundaries",
"description": "Learn how to avoid dependency hell and scale a codebase by imposing constraints on your projects using the module boundary lint rule.",
"id": "enforce-module-boundaries",
"tags": ["enforce-module-boundaries"],
"file": "shared/core-features/enforce-module-boundaries"
},
{
"name": "Integrate with Editors",
"description": "Learn about Nx Console, an extension for VS Code and WebStorm.",
"id": "integrate-with-editors",
"tags": ["integrate-with-editors"],
"file": "shared/core-features/integrate-with-editors"
},
{
"name": "Plugin Features",
"id": "plugin-features",

6
docs/nx-cloud/intro/nx-cloud.md
View File

@ -2,15 +2,15 @@
Nx partitions a command into smaller tasks and runs them in parallel, in the correct order. Nx Cloud takes it one step further and [runs any command across multiple machines](/core-features/distribute-task-execution), while giving you a consolidated view of the command as if it ran locally.
Nx caches the output of any previously run command such as testing and building, so it can replay the cached results instead of rerunning it. Nx Cloud allows you to [share the computation cache](/core-features/share-your-cache) across everyone in your team and CI.
Nx caches the output of any previously run command such as testing and building, so it can replay the cached results instead of rerunning it. Nx Cloud allows you to [share the computation cache](/core-features/remote-cache) across everyone in your team and CI.
And it takes five minutes to set up.
{% personas %}
{% persona type="cache" title="Share Your Cache" url="/core-features/share-your-cache" %}
{% persona type="cache" title="Share Your Cache" url="/core-features/remote-cache" %}
Share the computation cache across CI and developer machines
- [Set up distributed caching](/core-features/share-your-cache)
- [Set up distributed caching](/core-features/remote-cache)
{% /persona %}

4
docs/shared/angular-standalone-tutorial/angular-standalone.md
View File

@ -46,7 +46,7 @@ Create a new Angular application with the following command:
You get asked a few questions that help Nx preconfigure your new Angular application. These include
- Angular specific questions, such as whether you want to have the router set up for you, whether to use the Angular Standalone API and which stylesheet format to use
- General Nx questions, such as whether to enable distributed caching with Nx Cloud. Nx comes with built-in [local caching](/core-features/cache-task-results). If you want to benefit from this cache in CI, you can enable [distributed caching](/core-features/share-your-cache) which will set up [Nx Cloud](https://nx.app). This is also a prerequisite for enabling [distributed task execution](/core-features/distribute-task-execution).
- General Nx questions, such as whether to enable distributed caching with Nx Cloud. Nx comes with built-in [local caching](/core-features/cache-task-results). If you want to benefit from this cache in CI, you can enable [distributed caching](/core-features/remote-cache) which will set up [Nx Cloud](https://nx.app). This is also a prerequisite for enabling [distributed task execution](/core-features/distribute-task-execution).
For the sake of this tutorial, let's respond to all the questions with "yes".
@ -825,7 +825,7 @@ Here's some more things you can dive into next:
- Learn about popular generators such as [how to setup Tailwind](/recipes/angular/using-tailwind-css-with-angular-projects) or [add Storybook to your UI library](/packages/storybook/documents/overview-angular)
- Learn how to [migrate your existing Angular CLI repo to Nx](/recipes/angular/migration/angular)
- [Speed up CI: Run only tasks for project that got changed](/core-features/run-tasks#run-tasks-affected-by-a-pr)
- [Speed up CI: Share your cache](/core-features/share-your-cache)
- [Speed up CI: Share your cache](/core-features/remote-cache)
- [Speed up CI: Distribute your tasks across machines](/core-features/distribute-task-execution)
Also, make sure you

2
docs/shared/concepts/customizing-inputs.md
View File

@ -16,7 +16,7 @@ Knowing the syntax doesn't always explain how you would use the feature, so here
If you don't specify any `inputs`, Nx uses as inputs every file in the task's project and every file in that project's dependencies. It's the same as writing this:
```jsonc
```jsonc {% fileName="nx.json" %}
{
"namedInputs": {
"default": ["{projectRoot}/**/*"]

2
docs/shared/core-features/explore-graph.md
View File

@ -8,7 +8,7 @@ high level view of your code architecture.
To launch the project graph visualization run:
```shell
nx graph
npx nx graph
```
This will open a browser window with an interactive representation of the project graph of your current codebase.

35
docs/shared/core-features/share-your-cache.md → docs/shared/core-features/remote-cache.md
View File

@ -1,40 +1,22 @@
# Share Your Cache
# Use Remote Caching
The computation cache provided by Nx can be distributed across multiple machines. You can either build an implementation
of the cache or use Nx Cloud. Nx Cloud is an app that provides a fast and zero-config implementation of distributed
caching. It's completely free for OSS projects and for most closed-sourced
projects ([read more here](https://dev.to/nrwl/more-time-saved-for-free-with-nx-cloud-4a2j)).
The computation cache provided by Nx can be distributed across multiple machines. You can either build an implementation of the cache or use Nx Cloud. Nx Cloud is an app that provides a fast and zero-config implementation of distributed caching. It's completely free for OSS projects and for most closed-sourced
projects ([read more here](https://nx.app/pricing)).
![Diagram showing Teika sharing his cache with CI, Kimiko and James](/shared/images/dte/distributed-caching.svg)
In this diagram, Teika runs the build once on his machine, then CI, Kimiko and James can use the cached artifact from Teika instead of re-executing the same work.
## Connecting Your Workspace to Your Nx Cloud Account
You can connect your workspace to Nx Cloud by running:
```shell
npx nx connect-to-nx-cloud
```
```{% command="npx nx connect-to-nx-cloud"%}
✔ Enable distributed caching to make your CI faster · Yes
> NX Distributed caching via Nx Cloud has been enabled
In addition to the caching, Nx Cloud provides config-free distributed execution,
UI for viewing complex runs and GitHub integration. Learn more at https://nx.app
Your workspace is currently unclaimed. Run details from unclaimed workspaces can be viewed on cloud.nx.app by anyone
with the link. Claim your workspace at the following link to restrict access.
https://cloud.nx.app/orgs/workspace-setup?accessToken=YOURACCESSTOKEN
```
To see the remote cache in action, run:
```shell
nx build header && nx reset && nx build header
```
```{% command="nx build header && nx reset && nx build header"%}
> nx run header:build
@ -81,11 +63,11 @@ created dist in 786ms
Nx Cloud made it possible to reuse header: https://nx.app/runs/P0X6ZGTkqZ
```
## Connecting Your Workspace to Your Nx Cloud Account
## Claim your Nx Cloud Workspace
After you have enabled Nx Cloud in your workspace, you will see the following:
```shell
```plaintext
> NX NOTE Nx Cloud has been enabled
Your workspace is currently public. Anybody with code access
@ -109,5 +91,4 @@ account, and connect your workspace using the access token from `nx.json`.
## Skipping Cloud
Similar to how `--skip-nx-cache` will instruct Nx not to use the cache, passing `--no-cloud` will tell Nx not to use Nx
Cloud.
Similar to how `--skip-nx-cache` will instruct Nx not to use the local cache, passing `--no-cloud` will tell Nx not to use the remote cache from Nx Cloud.

2
docs/shared/guides/define-environment-variables.md
View File

@ -46,7 +46,7 @@ For example:
from `apps/my-app/.env`, it will notice that `NX_API_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](/core-features/share-your-cache)).
for workspace-specific settings (like the [Nx Cloud token](/core-features/remote-cache)).
{% /callout %}
### Pointing to custom env files

2
docs/shared/migration/adding-to-monorepo.md
View File

@ -9,7 +9,7 @@ Nx has first-class support for [package-based monorepos](/getting-started/tutori
- fast [task scheduling](/core-features/run-tasks)
- support for [task pipelines](/concepts/task-pipeline-configuration)
- [caching](/core-features/cache-task-results)
- optionally [remote caching with Nx Cloud](/core-features/share-your-cache)
- optionally [remote caching with Nx Cloud](/core-features/remote-cache)
- optionally [distributed task execution with Nx Cloud](/core-features/distribute-task-execution)
This is a low-impact operation because all that needs to be done is to install the `nx` package at the root level and add an `nx.json` for configuring caching and task pipelines.

2
docs/shared/react-standalone-tutorial/react-standalone.md
View File

@ -829,7 +829,7 @@ Here's some more things you can dive into next:
- [Learn how to setup Tailwind](/recipes/react/using-tailwind-css-in-react)
- [Setup Storybook for our shared UI library](/packages/storybook/documents/overview-react)
- [Speed up CI: Run only tasks for project that got changed](/core-features/run-tasks#run-tasks-affected-by-a-pr)]
- [Speed up CI: Share your cache](/core-features/share-your-cache)]
- [Speed up CI: Share your cache](/core-features/remote-cache)]
- [Speed up CI: Distribute your tasks across machines](/core-features/distribute-task-execution)
Also, make sure you

2
docs/shared/recipes/add-stack/add-lit.md
View File

@ -10,7 +10,7 @@ Because we are not using an Nx plugin for Lit, there are few items we'll have to
{% pill url="/core-features/run-tasks" %}✅ Run Tasks{% /pill %}
{% pill url="/core-features/cache-task-results" %}✅ Cache Task Results{% /pill %}
{% pill url="/core-features/share-your-cache" %}✅ Share Your Cache{% /pill %}
{% pill url="/core-features/remote-cache" %}✅ Share Your Cache{% /pill %}
{% pill url="/core-features/explore-graph" %}✅ Explore the Graph{% /pill %}
{% pill url="/core-features/distribute-task-execution" %}✅ Distribute Task Execution{% /pill %}
{% pill url="/core-features/integrate-with-editors" %}✅ Integrate with Editors{% /pill %}

2
docs/shared/reference/glossary.md
View File

@ -62,7 +62,7 @@ A set of preconfigured options for a [target](#target) that should be enabled al
A [cache](#cache) that can be shared between all developers using the repo and the CI system.
> See: [Share Your Cache](/core-features/share-your-cache)
> See: [Share Your Cache](/core-features/remote-cache)
### Distributed Task Execution

6
docs/shared/reference/sitemap.md
View File

@ -51,12 +51,12 @@
- [Core Features](/core-features)
- [Run Tasks](/core-features/run-tasks)
- [Cache Task Results](/core-features/cache-task-results)
- [Share Your Cache](/core-features/share-your-cache)
- [Explore the Graph](/core-features/explore-graph)
- [Use Remote Caching](/core-features/remote-cache)
- [Distribute Task Execution](/core-features/distribute-task-execution)
- [Integrate with Editors](/core-features/integrate-with-editors)
- [Explore the Graph](/core-features/explore-graph)
- [Automate Updating Dependencies](/core-features/automate-updating-dependencies)
- [Enforce Module Boundaries](/core-features/enforce-module-boundaries)
- [Integrate with Editors](/core-features/integrate-with-editors)
- [Plugin Features](/core-features/plugin-features)
- [Use Task Executors](/core-features/plugin-features/use-task-executors)
- [Use Code Generators](/core-features/plugin-features/use-code-generators)

9
nx-dev/nx-dev/redirect-rules.js
View File

@ -384,8 +384,8 @@ const recipesUrls = {
* Nx Cloud
*/
const nxCloudUrls = {
'/nx-cloud/set-up/add-nx-cloud': '/core-features/share-your-cache',
'/nx-cloud/set-up/set-up-caching': '/core-features/share-your-cache',
'/nx-cloud/set-up/add-nx-cloud': '/core-features/remote-cache',
'/nx-cloud/set-up/set-up-caching': '/core-features/remote-cache',
'/nx-cloud/set-up/set-up-dte': '/core-features/distribute-task-execution',
'/nx-cloud/private-cloud/standalone': '/nx-cloud/private-cloud/ami-setup',
'/nx-cloud/private-cloud/kubernetes-setup':
@ -831,6 +831,10 @@ const latestRecipesRefactoring = {
'/reference/commands': '/packages/nx',
};
const coreFeatureRefactoring = {
'/core-features/share-your-cache': '/core-features/remote-cache',
};
/**
* Public export API
*/
@ -855,4 +859,5 @@ module.exports = {
makeMoreConceptsSubmenu,
pluginsToExtendNx,
latestRecipesRefactoring,
coreFeatureRefactoring,
};