Skip to content

Commit

Permalink
docs(core): nx cloud features section (#20043)
Browse files Browse the repository at this point in the history
  • Loading branch information
@isaacplmann
isaacplmann authored Nov 7, 2023
1 parent 60cb992 commit 457bbcb
Show file tree
Hide file tree
Showing 58 changed files with 1,096 additions and 687 deletions.
548 changes: 355 additions & 193 deletions docs/generated/manifests/cloud.json
View file

Large diffs are not rendered by default.

468 changes: 291 additions & 177 deletions docs/generated/manifests/menus.json
View file

Large diffs are not rendered by default.

64 changes: 22 additions & 42 deletions docs/generated/manifests/nx.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -734,22 +734,22 @@
{
"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",
"description": "",
"file": "",
"itemList": [],
"isExternal": false,
"path": "/core-features/remote-cache",
"tags": ["remote-cache"]
"isExternal": true,
"path": "/nx-cloud/features/remote-cache",
"tags": []
},
{
"id": "distribute-task-execution",
"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.",
"file": "shared/core-features/distribute-task-execution",
"description": "",
"file": "",
"itemList": [],
"isExternal": false,
"path": "/core-features/distribute-task-execution",
"tags": ["distribute-task-execution"]
"isExternal": true,
"path": "/nx-cloud/features/distribute-task-execution",
"tags": []
},
{
"id": "explore-graph",
Expand Down Expand Up @@ -847,25 +847,25 @@
"path": "/core-features/cache-task-results",
"tags": ["cache-task-results"]
},
"/core-features/remote-cache": {
"/nx-cloud/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",
"description": "",
"file": "",
"itemList": [],
"isExternal": false,
"path": "/core-features/remote-cache",
"tags": ["remote-cache"]
"isExternal": true,
"path": "/nx-cloud/features/remote-cache",
"tags": []
},
"/core-features/distribute-task-execution": {
"/nx-cloud/features/distribute-task-execution": {
"id": "distribute-task-execution",
"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.",
"file": "shared/core-features/distribute-task-execution",
"description": "",
"file": "",
"itemList": [],
"isExternal": false,
"path": "/core-features/distribute-task-execution",
"tags": ["distribute-task-execution"]
"isExternal": true,
"path": "/nx-cloud/features/distribute-task-execution",
"tags": []
},
"/core-features/explore-graph": {
"id": "explore-graph",
Expand Down Expand Up @@ -1014,16 +1014,6 @@
"path": "/concepts/task-pipeline-configuration",
"tags": ["run-tasks", "use-task-executors"]
},
{
"id": "affected",
"name": "How Affected Works",
"description": "",
"file": "shared/using-nx/affected",
"itemList": [],
"isExternal": false,
"path": "/concepts/affected",
"tags": ["run-tasks"]
},
{
"id": "integrated-vs-package-based",
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
Expand Down Expand Up @@ -1326,16 +1316,6 @@
"path": "/concepts/task-pipeline-configuration",
"tags": ["run-tasks", "use-task-executors"]
},
"/concepts/affected": {
"id": "affected",
"name": "How Affected Works",
"description": "",
"file": "shared/using-nx/affected",
"itemList": [],
"isExternal": false,
"path": "/concepts/affected",
"tags": ["run-tasks"]
},
"/concepts/integrated-vs-package-based": {
"id": "integrated-vs-package-based",
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
Expand Down
129 changes: 69 additions & 60 deletions docs/generated/manifests/tags.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@
"name": "What is a Task Pipeline",
"path": "/concepts/task-pipeline-configuration"
},
{
"description": "",
"file": "shared/using-nx/affected",
"id": "affected",
"name": "How Affected Works",
"path": "/concepts/affected"
},
{
"description": "",
"file": "shared/recipes/running-tasks/customizing-inputs",
Expand Down Expand Up @@ -63,6 +56,13 @@
"name": "Workspace Watching",
"path": "/recipes/running-tasks/workspace-watching"
},
{
"description": "",
"file": "shared/using-nx/affected",
"id": "affected",
"name": "Run Only Tasks Affected by a PR",
"path": "/nx-cloud/features/affected"
},
{
"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/run",
Expand Down Expand Up @@ -171,59 +171,6 @@
"path": "/nx-api/nx/documents/reset"
}
],
"remote-cache": [
{
"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": "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",
"path": "/core-features/distribute-task-execution"
},
{
"description": "",
"file": "shared/concepts/improve-worst-case-ci-times",
"id": "dte",
"name": "Improve Worst Case CI Times",
"path": "/concepts/dte"
},
{
"description": "",
"file": "shared/concepts/illustrated-dte-guide",
"id": "illustrated-dte",
"name": "Illustrated Distributed Task Execution",
"path": "/concepts/more-concepts/illustrated-dte"
},
{
"description": "",
"file": "",
"id": "nx-cloud-documentation",
"name": "Nx Cloud Documentation",
"path": "/nx-cloud/intro/ci-with-nx"
},
{
"description": "",
"file": "shared/ci-overview",
"id": "ci-setup",
"name": "CI Setup",
"path": "/nx-cloud/recipes/set-up/ci-setup"
},
{
"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/connect-to-nx-cloud",
"id": "connect-to-nx-cloud",
"name": "connect-to-nx-cloud",
"path": "/nx-api/nx/documents/connect-to-nx-cloud"
}
],
"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.",
Expand Down Expand Up @@ -637,6 +584,50 @@
"path": "/concepts/integrated-vs-package-based"
}
],
"distribute-task-execution": [
{
"description": "",
"file": "shared/concepts/improve-worst-case-ci-times",
"id": "dte",
"name": "Improve Worst Case CI Times",
"path": "/concepts/dte"
},
{
"description": "",
"file": "shared/concepts/illustrated-dte-guide",
"id": "illustrated-dte",
"name": "Illustrated Distributed Task Execution",
"path": "/concepts/more-concepts/illustrated-dte"
},
{
"description": "",
"file": "",
"id": "nx-cloud-documentation",
"name": "Nx Cloud Documentation",
"path": "/nx-cloud/intro/ci-with-nx"
},
{
"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",
"path": "/nx-cloud/features/distribute-task-execution"
},
{
"description": "",
"file": "shared/ci-overview",
"id": "ci-setup",
"name": "CI Setup",
"path": "/nx-cloud/recipes/set-up/ci-setup"
},
{
"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/connect-to-nx-cloud",
"id": "connect-to-nx-cloud",
"name": "connect-to-nx-cloud",
"path": "/nx-api/nx/documents/connect-to-nx-cloud"
}
],
"repository-types": [
{
"description": "",
Expand Down Expand Up @@ -1156,6 +1147,24 @@
"path": "/showcase/example-repos/serverless-fastify-planetscale"
}
],
"remote-cache": [
{
"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": "/nx-cloud/features/remote-cache"
}
],
"on-premise": [
{
"description": "Set up Nx Cloud on machines that you control",
"file": "nx-cloud/private/get-started",
"id": "on-premise",
"name": "Set up Nx Cloud On-Premise",
"path": "/nx-cloud/features/on-premise"
}
],
"docker": [
{
"description": "",
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/jest/executors/jest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@
}
},
"required": ["jestConfig"],
"examplesFile": "Jest can be configured in many ways, but primarily you'll need to at least have the jestConfig options\n\n```json\n\"test\": {\n \"executor\": \"@nx/jest:jest\",\n \"options\": {\n \"jestConfig\": \"libs/my-lib/jest.config.ts\"\n }\n}\n```\n\nIt is also helpful to have `passWithNoTests: true` set so your project doesn't fail testing while tests are still being added.\n\n```json\n\"test\": {\n \"executor\": \"@nx/jest:jest\",\n \"options\": {\n \"jestConfig\": \"libs/my-lib/jest.config.ts\",\n \"passWithNoTests\": true\n }\n}\n```\n\n### Snapshots\n\nUpdate snapshots running with `--update-snapshot` or `-u` for short.\n\n```bash\nnx test my-project -u\n```\n\nOther times you might not want to allow updating snapshots such as in CI.\nAdding a _ci_ configuration is helpful for adding this behavior.\n\n```json\n\"test\": {\n \"executor\": \"@nx/jest:jest\",\n \"options\": {\n \"jestConfig\": \"libs/my-lib/jest.config.ts\",\n \"passWithNoTests\": true\n },\n \"configurations\": {\n \"ci\": {\n \"ci\": true\n }\n }\n}\n```\n\n```bash\nnx affected --target=test --configuration=ci\n```\n\nLearn more [about _affected_](/concepts/affected)\n"
"examplesFile": "Jest can be configured in many ways, but primarily you'll need to at least have the jestConfig options\n\n```json\n\"test\": {\n \"executor\": \"@nx/jest:jest\",\n \"options\": {\n \"jestConfig\": \"libs/my-lib/jest.config.ts\"\n }\n}\n```\n\nIt is also helpful to have `passWithNoTests: true` set so your project doesn't fail testing while tests are still being added.\n\n```json\n\"test\": {\n \"executor\": \"@nx/jest:jest\",\n \"options\": {\n \"jestConfig\": \"libs/my-lib/jest.config.ts\",\n \"passWithNoTests\": true\n }\n}\n```\n\n### Snapshots\n\nUpdate snapshots running with `--update-snapshot` or `-u` for short.\n\n```bash\nnx test my-project -u\n```\n\nOther times you might not want to allow updating snapshots such as in CI.\nAdding a _ci_ configuration is helpful for adding this behavior.\n\n```json\n\"test\": {\n \"executor\": \"@nx/jest:jest\",\n \"options\": {\n \"jestConfig\": \"libs/my-lib/jest.config.ts\",\n \"passWithNoTests\": true\n },\n \"configurations\": {\n \"ci\": {\n \"ci\": true\n }\n }\n}\n```\n\n```bash\nnx affected --target=test --configuration=ci\n```\n\nLearn more [about _affected_](/nx-cloud/features/affected)\n"
},
"description": "Run Jest unit tests.",
"aliases": [],
Expand Down
Loading

1 comment on commit 457bbcb

@vercel
Copy link

@vercel vercel bot commented on 457bbcb Nov 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx-dev-git-master-nrwl.vercel.app
nx.dev

Please sign in to comment.