diff --git a/docs/generated/manifests/ci.json b/docs/generated/manifests/ci.json index 36cb5b5882..97d891b093 100644 --- a/docs/generated/manifests/ci.json +++ b/docs/generated/manifests/ci.json @@ -798,29 +798,6 @@ "path": "/ci/recipes/enterprise", "tags": [] }, - { - "id": "troubleshooting", - "name": "Troubleshooting", - "description": "Learn how to solve common issues in Nx Cloud.", - "mediaImage": "", - "file": "", - "itemList": [ - { - "id": "ci-execution-failed", - "name": "CI Execution Failed", - "description": "", - "mediaImage": "", - "file": "nx-cloud/troubleshooting/ci-execution-failed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/troubleshooting/ci-execution-failed", - "tags": [] - } - ], - "isExternal": false, - "path": "/ci/recipes/troubleshooting", - "tags": [] - }, { "id": "other", "name": "Other", @@ -1726,40 +1703,6 @@ "path": "/ci/recipes/enterprise/dte/jenkins-dte", "tags": [] }, - "/ci/recipes/troubleshooting": { - "id": "troubleshooting", - "name": "Troubleshooting", - "description": "Learn how to solve common issues in Nx Cloud.", - "mediaImage": "", - "file": "", - "itemList": [ - { - "id": "ci-execution-failed", - "name": "CI Execution Failed", - "description": "", - "mediaImage": "", - "file": "nx-cloud/troubleshooting/ci-execution-failed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/troubleshooting/ci-execution-failed", - "tags": [] - } - ], - "isExternal": false, - "path": "/ci/recipes/troubleshooting", - "tags": [] - }, - "/ci/recipes/troubleshooting/ci-execution-failed": { - "id": "ci-execution-failed", - "name": "CI Execution Failed", - "description": "", - "mediaImage": "", - "file": "nx-cloud/troubleshooting/ci-execution-failed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/troubleshooting/ci-execution-failed", - "tags": [] - }, "/ci/recipes/other": { "id": "other", "name": "Other", @@ -1937,5 +1880,39 @@ "isExternal": false, "path": "/ci/reference/release-notes", "tags": [] + }, + "/ci/troubleshooting": { + "id": "troubleshooting", + "name": "Troubleshooting", + "description": "Learn how to solve common issues in Nx Cloud.", + "mediaImage": "", + "file": "", + "itemList": [ + { + "id": "ci-execution-failed", + "name": "CI Execution Failed", + "description": "", + "mediaImage": "", + "file": "nx-cloud/troubleshooting/ci-execution-failed", + "itemList": [], + "isExternal": false, + "path": "/ci/troubleshooting/ci-execution-failed", + "tags": [] + } + ], + "isExternal": false, + "path": "/ci/troubleshooting", + "tags": [] + }, + "/ci/troubleshooting/ci-execution-failed": { + "id": "ci-execution-failed", + "name": "CI Execution Failed", + "description": "", + "mediaImage": "", + "file": "nx-cloud/troubleshooting/ci-execution-failed", + "itemList": [], + "isExternal": false, + "path": "/ci/troubleshooting/ci-execution-failed", + "tags": [] } } diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index dc7d934473..a355976406 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -1308,6 +1308,31 @@ "id": "recipes", "isExternal": false, "children": [ + { + "name": "Installation", + "path": "/recipes/installation", + "id": "installation", + "isExternal": false, + "children": [ + { + "name": "Install Nx in a Non-Javascript Repo", + "path": "/recipes/installation/install-non-javascript", + "id": "install-non-javascript", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Update Your Global Nx Installation", + "path": "/recipes/installation/update-global-installation", + "id": "update-global-installation", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, { "name": "Tasks & Caching", "path": "/recipes/running-tasks", @@ -1930,31 +1955,6 @@ ], "disableCollapsible": false }, - { - "name": "Installation", - "path": "/recipes/installation", - "id": "installation", - "isExternal": false, - "children": [ - { - "name": "Install Nx in a Non-Javascript Repo", - "path": "/recipes/installation/install-non-javascript", - "id": "install-non-javascript", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Update Your Global Nx Installation", - "path": "/recipes/installation/update-global-installation", - "id": "update-global-installation", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, { "name": "Tips and tricks", "path": "/recipes/tips-n-tricks", @@ -2108,55 +2108,6 @@ ], "disableCollapsible": false }, - { - "name": "Troubleshooting", - "path": "/recipes/troubleshooting", - "id": "troubleshooting", - "isExternal": false, - "children": [ - { - "name": "Resolve Circular Dependencies", - "path": "/recipes/troubleshooting/resolve-circular-dependencies", - "id": "resolve-circular-dependencies", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Troubleshooting Nx Install Issues", - "path": "/recipes/troubleshooting/troubleshoot-nx-install-issues", - "id": "troubleshoot-nx-install-issues", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Troubleshoot Cache Misses", - "path": "/recipes/troubleshooting/troubleshoot-cache-misses", - "id": "troubleshoot-cache-misses", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Unknown Local Cache Error", - "path": "/recipes/troubleshooting/unknown-local-cache", - "id": "unknown-local-cache", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Profiling Build Performance", - "path": "/recipes/troubleshooting/performance-profiling", - "id": "performance-profiling", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, { "name": "Nx Console", "path": "/recipes/nx-console", @@ -2307,6 +2258,47 @@ ], "disableCollapsible": false }, + { + "name": "Installation", + "path": "/recipes/installation", + "id": "installation", + "isExternal": false, + "children": [ + { + "name": "Install Nx in a Non-Javascript Repo", + "path": "/recipes/installation/install-non-javascript", + "id": "install-non-javascript", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Update Your Global Nx Installation", + "path": "/recipes/installation/update-global-installation", + "id": "update-global-installation", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "Install Nx in a Non-Javascript Repo", + "path": "/recipes/installation/install-non-javascript", + "id": "install-non-javascript", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Update Your Global Nx Installation", + "path": "/recipes/installation/update-global-installation", + "id": "update-global-installation", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Tasks & Caching", "path": "/recipes/running-tasks", @@ -3450,47 +3442,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Installation", - "path": "/recipes/installation", - "id": "installation", - "isExternal": false, - "children": [ - { - "name": "Install Nx in a Non-Javascript Repo", - "path": "/recipes/installation/install-non-javascript", - "id": "install-non-javascript", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Update Your Global Nx Installation", - "path": "/recipes/installation/update-global-installation", - "id": "update-global-installation", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, - { - "name": "Install Nx in a Non-Javascript Repo", - "path": "/recipes/installation/install-non-javascript", - "id": "install-non-javascript", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Update Your Global Nx Installation", - "path": "/recipes/installation/update-global-installation", - "id": "update-global-installation", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Tips and tricks", "path": "/recipes/tips-n-tricks", @@ -3788,95 +3739,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Troubleshooting", - "path": "/recipes/troubleshooting", - "id": "troubleshooting", - "isExternal": false, - "children": [ - { - "name": "Resolve Circular Dependencies", - "path": "/recipes/troubleshooting/resolve-circular-dependencies", - "id": "resolve-circular-dependencies", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Troubleshooting Nx Install Issues", - "path": "/recipes/troubleshooting/troubleshoot-nx-install-issues", - "id": "troubleshoot-nx-install-issues", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Troubleshoot Cache Misses", - "path": "/recipes/troubleshooting/troubleshoot-cache-misses", - "id": "troubleshoot-cache-misses", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Unknown Local Cache Error", - "path": "/recipes/troubleshooting/unknown-local-cache", - "id": "unknown-local-cache", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Profiling Build Performance", - "path": "/recipes/troubleshooting/performance-profiling", - "id": "performance-profiling", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, - { - "name": "Resolve Circular Dependencies", - "path": "/recipes/troubleshooting/resolve-circular-dependencies", - "id": "resolve-circular-dependencies", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Troubleshooting Nx Install Issues", - "path": "/recipes/troubleshooting/troubleshoot-nx-install-issues", - "id": "troubleshoot-nx-install-issues", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Troubleshoot Cache Misses", - "path": "/recipes/troubleshooting/troubleshoot-cache-misses", - "id": "troubleshoot-cache-misses", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Unknown Local Cache Error", - "path": "/recipes/troubleshooting/unknown-local-cache", - "id": "unknown-local-cache", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Profiling Build Performance", - "path": "/recipes/troubleshooting/performance-profiling", - "id": "performance-profiling", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Nx Console", "path": "/recipes/nx-console", @@ -4766,6 +4628,95 @@ "children": [], "disableCollapsible": false }, + { + "name": "Troubleshooting", + "path": "/troubleshooting", + "id": "troubleshooting", + "isExternal": false, + "children": [ + { + "name": "Resolve Circular Dependencies", + "path": "/troubleshooting/resolve-circular-dependencies", + "id": "resolve-circular-dependencies", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Troubleshooting Nx Install Issues", + "path": "/troubleshooting/troubleshoot-nx-install-issues", + "id": "troubleshoot-nx-install-issues", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Troubleshoot Cache Misses", + "path": "/troubleshooting/troubleshoot-cache-misses", + "id": "troubleshoot-cache-misses", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Unknown Local Cache Error", + "path": "/troubleshooting/unknown-local-cache", + "id": "unknown-local-cache", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Profiling Build Performance", + "path": "/troubleshooting/performance-profiling", + "id": "performance-profiling", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "Resolve Circular Dependencies", + "path": "/troubleshooting/resolve-circular-dependencies", + "id": "resolve-circular-dependencies", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Troubleshooting Nx Install Issues", + "path": "/troubleshooting/troubleshoot-nx-install-issues", + "id": "troubleshoot-nx-install-issues", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Troubleshoot Cache Misses", + "path": "/troubleshooting/troubleshoot-cache-misses", + "id": "troubleshoot-cache-misses", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Unknown Local Cache Error", + "path": "/troubleshooting/unknown-local-cache", + "id": "unknown-local-cache", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Profiling Build Performance", + "path": "/troubleshooting/performance-profiling", + "id": "performance-profiling", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Deprecated", "path": "/deprecated", @@ -6104,23 +6055,6 @@ ], "disableCollapsible": false }, - { - "name": "Troubleshooting", - "path": "/ci/recipes/troubleshooting", - "id": "troubleshooting", - "isExternal": false, - "children": [ - { - "name": "CI Execution Failed", - "path": "/ci/recipes/troubleshooting/ci-execution-failed", - "id": "ci-execution-failed", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, { "name": "Other", "path": "/ci/recipes/other", @@ -6781,31 +6715,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Troubleshooting", - "path": "/ci/recipes/troubleshooting", - "id": "troubleshooting", - "isExternal": false, - "children": [ - { - "name": "CI Execution Failed", - "path": "/ci/recipes/troubleshooting/ci-execution-failed", - "id": "ci-execution-failed", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, - { - "name": "CI Execution Failed", - "path": "/ci/recipes/troubleshooting/ci-execution-failed", - "id": "ci-execution-failed", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Other", "path": "/ci/recipes/other", @@ -6935,6 +6844,31 @@ "isExternal": false, "children": [], "disableCollapsible": false + }, + { + "name": "Troubleshooting", + "path": "/ci/troubleshooting", + "id": "troubleshooting", + "isExternal": false, + "children": [ + { + "name": "CI Execution Failed", + "path": "/ci/troubleshooting/ci-execution-failed", + "id": "ci-execution-failed", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "CI Execution Failed", + "path": "/ci/troubleshooting/ci-execution-failed", + "id": "ci-execution-failed", + "isExternal": false, + "children": [], + "disableCollapsible": false } ] }, diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index 6c28c8382b..62a378817c 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -1789,6 +1789,40 @@ "mediaImage": "", "file": "", "itemList": [ + { + "id": "installation", + "name": "Installation", + "description": "Installing Nx", + "mediaImage": "", + "file": "", + "itemList": [ + { + "id": "install-non-javascript", + "name": "Install Nx in a Non-Javascript Repo", + "description": "", + "mediaImage": "", + "file": "shared/recipes/installation/install-non-javascript", + "itemList": [], + "isExternal": false, + "path": "/recipes/installation/install-non-javascript", + "tags": ["installation"] + }, + { + "id": "update-global-installation", + "name": "Update Your Global Nx Installation", + "description": "", + "mediaImage": "", + "file": "shared/recipes/installation/update-global-installation", + "itemList": [], + "isExternal": false, + "path": "/recipes/installation/update-global-installation", + "tags": ["installation"] + } + ], + "isExternal": false, + "path": "/recipes/installation", + "tags": [] + }, { "id": "running-tasks", "name": "Tasks & Caching", @@ -2639,40 +2673,6 @@ "path": "/recipes/enforce-module-boundaries", "tags": [] }, - { - "id": "installation", - "name": "Installation", - "description": "Installing Nx", - "mediaImage": "", - "file": "", - "itemList": [ - { - "id": "install-non-javascript", - "name": "Install Nx in a Non-Javascript Repo", - "description": "", - "mediaImage": "", - "file": "shared/recipes/installation/install-non-javascript", - "itemList": [], - "isExternal": false, - "path": "/recipes/installation/install-non-javascript", - "tags": ["installation"] - }, - { - "id": "update-global-installation", - "name": "Update Your Global Nx Installation", - "description": "", - "mediaImage": "", - "file": "shared/recipes/installation/update-global-installation", - "itemList": [], - "isExternal": false, - "path": "/recipes/installation/update-global-installation", - "tags": ["installation"] - } - ], - "isExternal": false, - "path": "/recipes/installation", - "tags": [] - }, { "id": "tips-n-tricks", "name": "Tips and tricks", @@ -2883,73 +2883,6 @@ "path": "/recipes/tips-n-tricks", "tags": [] }, - { - "id": "troubleshooting", - "name": "Troubleshooting", - "description": "Learn how to troubleshoot common problems.", - "mediaImage": "", - "file": "", - "itemList": [ - { - "id": "resolve-circular-dependencies", - "name": "Resolve Circular Dependencies", - "description": "", - "mediaImage": "", - "file": "shared/recipes/resolve-circular-dependencies", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/resolve-circular-dependencies", - "tags": ["explore-graph"] - }, - { - "id": "troubleshoot-nx-install-issues", - "name": "Troubleshooting Nx Install Issues", - "description": "", - "mediaImage": "", - "file": "shared/installation/troubleshoot-installation", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/troubleshoot-nx-install-issues", - "tags": [] - }, - { - "id": "troubleshoot-cache-misses", - "name": "Troubleshoot Cache Misses", - "description": "", - "mediaImage": "", - "file": "shared/recipes/troubleshoot-cache-misses", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/troubleshoot-cache-misses", - "tags": ["cache-task-results"] - }, - { - "id": "unknown-local-cache", - "name": "Unknown Local Cache Error", - "description": "", - "mediaImage": "", - "file": "shared/guides/unknown-local-cache", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/unknown-local-cache", - "tags": [] - }, - { - "id": "performance-profiling", - "name": "Profiling Build Performance", - "description": "", - "mediaImage": "", - "file": "shared/guides/performance-profiling", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/performance-profiling", - "tags": ["environment-variables"] - } - ], - "isExternal": false, - "path": "/recipes/troubleshooting", - "tags": [] - }, { "id": "nx-console", "name": "Nx Console", @@ -3156,6 +3089,62 @@ "path": "/recipes", "tags": [] }, + "/recipes/installation": { + "id": "installation", + "name": "Installation", + "description": "Installing Nx", + "mediaImage": "", + "file": "", + "itemList": [ + { + "id": "install-non-javascript", + "name": "Install Nx in a Non-Javascript Repo", + "description": "", + "mediaImage": "", + "file": "shared/recipes/installation/install-non-javascript", + "itemList": [], + "isExternal": false, + "path": "/recipes/installation/install-non-javascript", + "tags": ["installation"] + }, + { + "id": "update-global-installation", + "name": "Update Your Global Nx Installation", + "description": "", + "mediaImage": "", + "file": "shared/recipes/installation/update-global-installation", + "itemList": [], + "isExternal": false, + "path": "/recipes/installation/update-global-installation", + "tags": ["installation"] + } + ], + "isExternal": false, + "path": "/recipes/installation", + "tags": [] + }, + "/recipes/installation/install-non-javascript": { + "id": "install-non-javascript", + "name": "Install Nx in a Non-Javascript Repo", + "description": "", + "mediaImage": "", + "file": "shared/recipes/installation/install-non-javascript", + "itemList": [], + "isExternal": false, + "path": "/recipes/installation/install-non-javascript", + "tags": ["installation"] + }, + "/recipes/installation/update-global-installation": { + "id": "update-global-installation", + "name": "Update Your Global Nx Installation", + "description": "", + "mediaImage": "", + "file": "shared/recipes/installation/update-global-installation", + "itemList": [], + "isExternal": false, + "path": "/recipes/installation/update-global-installation", + "tags": ["installation"] + }, "/recipes/running-tasks": { "id": "running-tasks", "name": "Tasks & Caching", @@ -4722,62 +4711,6 @@ "path": "/recipes/enforce-module-boundaries/tags-allow-list", "tags": ["enforce-module-boundaries"] }, - "/recipes/installation": { - "id": "installation", - "name": "Installation", - "description": "Installing Nx", - "mediaImage": "", - "file": "", - "itemList": [ - { - "id": "install-non-javascript", - "name": "Install Nx in a Non-Javascript Repo", - "description": "", - "mediaImage": "", - "file": "shared/recipes/installation/install-non-javascript", - "itemList": [], - "isExternal": false, - "path": "/recipes/installation/install-non-javascript", - "tags": ["installation"] - }, - { - "id": "update-global-installation", - "name": "Update Your Global Nx Installation", - "description": "", - "mediaImage": "", - "file": "shared/recipes/installation/update-global-installation", - "itemList": [], - "isExternal": false, - "path": "/recipes/installation/update-global-installation", - "tags": ["installation"] - } - ], - "isExternal": false, - "path": "/recipes/installation", - "tags": [] - }, - "/recipes/installation/install-non-javascript": { - "id": "install-non-javascript", - "name": "Install Nx in a Non-Javascript Repo", - "description": "", - "mediaImage": "", - "file": "shared/recipes/installation/install-non-javascript", - "itemList": [], - "isExternal": false, - "path": "/recipes/installation/install-non-javascript", - "tags": ["installation"] - }, - "/recipes/installation/update-global-installation": { - "id": "update-global-installation", - "name": "Update Your Global Nx Installation", - "description": "", - "mediaImage": "", - "file": "shared/recipes/installation/update-global-installation", - "itemList": [], - "isExternal": false, - "path": "/recipes/installation/update-global-installation", - "tags": ["installation"] - }, "/recipes/tips-n-tricks": { "id": "tips-n-tricks", "name": "Tips and tricks", @@ -5186,128 +5119,6 @@ "path": "/recipes/tips-n-tricks/flat-config", "tags": ["eslint", "flat config"] }, - "/recipes/troubleshooting": { - "id": "troubleshooting", - "name": "Troubleshooting", - "description": "Learn how to troubleshoot common problems.", - "mediaImage": "", - "file": "", - "itemList": [ - { - "id": "resolve-circular-dependencies", - "name": "Resolve Circular Dependencies", - "description": "", - "mediaImage": "", - "file": "shared/recipes/resolve-circular-dependencies", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/resolve-circular-dependencies", - "tags": ["explore-graph"] - }, - { - "id": "troubleshoot-nx-install-issues", - "name": "Troubleshooting Nx Install Issues", - "description": "", - "mediaImage": "", - "file": "shared/installation/troubleshoot-installation", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/troubleshoot-nx-install-issues", - "tags": [] - }, - { - "id": "troubleshoot-cache-misses", - "name": "Troubleshoot Cache Misses", - "description": "", - "mediaImage": "", - "file": "shared/recipes/troubleshoot-cache-misses", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/troubleshoot-cache-misses", - "tags": ["cache-task-results"] - }, - { - "id": "unknown-local-cache", - "name": "Unknown Local Cache Error", - "description": "", - "mediaImage": "", - "file": "shared/guides/unknown-local-cache", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/unknown-local-cache", - "tags": [] - }, - { - "id": "performance-profiling", - "name": "Profiling Build Performance", - "description": "", - "mediaImage": "", - "file": "shared/guides/performance-profiling", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/performance-profiling", - "tags": ["environment-variables"] - } - ], - "isExternal": false, - "path": "/recipes/troubleshooting", - "tags": [] - }, - "/recipes/troubleshooting/resolve-circular-dependencies": { - "id": "resolve-circular-dependencies", - "name": "Resolve Circular Dependencies", - "description": "", - "mediaImage": "", - "file": "shared/recipes/resolve-circular-dependencies", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/resolve-circular-dependencies", - "tags": ["explore-graph"] - }, - "/recipes/troubleshooting/troubleshoot-nx-install-issues": { - "id": "troubleshoot-nx-install-issues", - "name": "Troubleshooting Nx Install Issues", - "description": "", - "mediaImage": "", - "file": "shared/installation/troubleshoot-installation", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/troubleshoot-nx-install-issues", - "tags": [] - }, - "/recipes/troubleshooting/troubleshoot-cache-misses": { - "id": "troubleshoot-cache-misses", - "name": "Troubleshoot Cache Misses", - "description": "", - "mediaImage": "", - "file": "shared/recipes/troubleshoot-cache-misses", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/troubleshoot-cache-misses", - "tags": ["cache-task-results"] - }, - "/recipes/troubleshooting/unknown-local-cache": { - "id": "unknown-local-cache", - "name": "Unknown Local Cache Error", - "description": "", - "mediaImage": "", - "file": "shared/guides/unknown-local-cache", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/unknown-local-cache", - "tags": [] - }, - "/recipes/troubleshooting/performance-profiling": { - "id": "performance-profiling", - "name": "Profiling Build Performance", - "description": "", - "mediaImage": "", - "file": "shared/guides/performance-profiling", - "itemList": [], - "isExternal": false, - "path": "/recipes/troubleshooting/performance-profiling", - "tags": ["environment-variables"] - }, "/recipes/nx-console": { "id": "nx-console", "name": "Nx Console", @@ -6527,6 +6338,128 @@ "path": "/reference/glossary", "tags": [] }, + "/troubleshooting": { + "id": "troubleshooting", + "name": "Troubleshooting", + "description": "Learn how to troubleshoot common problems.", + "mediaImage": "", + "file": "", + "itemList": [ + { + "id": "resolve-circular-dependencies", + "name": "Resolve Circular Dependencies", + "description": "", + "mediaImage": "", + "file": "shared/recipes/resolve-circular-dependencies", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/resolve-circular-dependencies", + "tags": ["explore-graph"] + }, + { + "id": "troubleshoot-nx-install-issues", + "name": "Troubleshooting Nx Install Issues", + "description": "", + "mediaImage": "", + "file": "shared/installation/troubleshoot-installation", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/troubleshoot-nx-install-issues", + "tags": [] + }, + { + "id": "troubleshoot-cache-misses", + "name": "Troubleshoot Cache Misses", + "description": "", + "mediaImage": "", + "file": "shared/recipes/troubleshoot-cache-misses", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/troubleshoot-cache-misses", + "tags": ["cache-task-results"] + }, + { + "id": "unknown-local-cache", + "name": "Unknown Local Cache Error", + "description": "", + "mediaImage": "", + "file": "shared/guides/unknown-local-cache", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/unknown-local-cache", + "tags": [] + }, + { + "id": "performance-profiling", + "name": "Profiling Build Performance", + "description": "", + "mediaImage": "", + "file": "shared/guides/performance-profiling", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/performance-profiling", + "tags": ["environment-variables"] + } + ], + "isExternal": false, + "path": "/troubleshooting", + "tags": [] + }, + "/troubleshooting/resolve-circular-dependencies": { + "id": "resolve-circular-dependencies", + "name": "Resolve Circular Dependencies", + "description": "", + "mediaImage": "", + "file": "shared/recipes/resolve-circular-dependencies", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/resolve-circular-dependencies", + "tags": ["explore-graph"] + }, + "/troubleshooting/troubleshoot-nx-install-issues": { + "id": "troubleshoot-nx-install-issues", + "name": "Troubleshooting Nx Install Issues", + "description": "", + "mediaImage": "", + "file": "shared/installation/troubleshoot-installation", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/troubleshoot-nx-install-issues", + "tags": [] + }, + "/troubleshooting/troubleshoot-cache-misses": { + "id": "troubleshoot-cache-misses", + "name": "Troubleshoot Cache Misses", + "description": "", + "mediaImage": "", + "file": "shared/recipes/troubleshoot-cache-misses", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/troubleshoot-cache-misses", + "tags": ["cache-task-results"] + }, + "/troubleshooting/unknown-local-cache": { + "id": "unknown-local-cache", + "name": "Unknown Local Cache Error", + "description": "", + "mediaImage": "", + "file": "shared/guides/unknown-local-cache", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/unknown-local-cache", + "tags": [] + }, + "/troubleshooting/performance-profiling": { + "id": "performance-profiling", + "name": "Profiling Build Performance", + "description": "", + "mediaImage": "", + "file": "shared/guides/performance-profiling", + "itemList": [], + "isExternal": false, + "path": "/troubleshooting/performance-profiling", + "tags": ["environment-variables"] + }, "/deprecated": { "id": "deprecated", "name": "Deprecated", diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index 796d68a90e..802914176f 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -186,13 +186,6 @@ "name": "Configure Outputs for Task Caching", "path": "/recipes/running-tasks/configure-outputs" }, - { - "description": "", - "file": "shared/recipes/troubleshoot-cache-misses", - "id": "troubleshoot-cache-misses", - "name": "Troubleshoot Cache Misses", - "path": "/recipes/troubleshooting/troubleshoot-cache-misses" - }, { "description": "", "file": "shared/reference/inputs", @@ -200,6 +193,13 @@ "name": "Inputs and Named Inputs", "path": "/reference/inputs" }, + { + "description": "", + "file": "shared/recipes/troubleshoot-cache-misses", + "id": "troubleshoot-cache-misses", + "name": "Troubleshoot Cache Misses", + "path": "/troubleshooting/troubleshoot-cache-misses" + }, { "description": "", "file": "", @@ -277,7 +277,7 @@ "file": "shared/recipes/resolve-circular-dependencies", "id": "resolve-circular-dependencies", "name": "Resolve Circular Dependencies", - "path": "/recipes/troubleshooting/resolve-circular-dependencies" + "path": "/troubleshooting/resolve-circular-dependencies" }, { "description": "", @@ -785,6 +785,22 @@ "path": "/recipes/react/module-federation-with-ssr" } ], + "installation": [ + { + "description": "", + "file": "shared/recipes/installation/install-non-javascript", + "id": "install-non-javascript", + "name": "Install Nx in a Non-Javascript Repo", + "path": "/recipes/installation/install-non-javascript" + }, + { + "description": "", + "file": "shared/recipes/installation/update-global-installation", + "id": "update-global-installation", + "name": "Update Your Global Nx Installation", + "path": "/recipes/installation/update-global-installation" + } + ], "workspace-watching": [ { "description": "", @@ -823,19 +839,19 @@ "name": "Define Environment Variables", "path": "/recipes/tips-n-tricks/define-environment-variables" }, - { - "description": "", - "file": "shared/guides/performance-profiling", - "id": "performance-profiling", - "name": "Profiling Build Performance", - "path": "/recipes/troubleshooting/performance-profiling" - }, { "description": "", "file": "shared/reference/environment-variables", "id": "environment-variables", "name": "Environment Variables", "path": "/reference/environment-variables" + }, + { + "description": "", + "file": "shared/guides/performance-profiling", + "id": "performance-profiling", + "name": "Profiling Build Performance", + "path": "/troubleshooting/performance-profiling" } ], "deployment": [ @@ -1019,22 +1035,6 @@ "path": "/recipes/storybook/angular-configuring-styles" } ], - "installation": [ - { - "description": "", - "file": "shared/recipes/installation/install-non-javascript", - "id": "install-non-javascript", - "name": "Install Nx in a Non-Javascript Repo", - "path": "/recipes/installation/install-non-javascript" - }, - { - "description": "", - "file": "shared/recipes/installation/update-global-installation", - "id": "update-global-installation", - "name": "Update Your Global Nx Installation", - "path": "/recipes/installation/update-global-installation" - } - ], "yarn": [ { "description": "", diff --git a/docs/map.json b/docs/map.json index 132fc5c2be..2a94ce8f9f 100644 --- a/docs/map.json +++ b/docs/map.json @@ -413,6 +413,25 @@ "id": "recipes", "description": "In depth recipes for common tasks", "itemList": [ + { + "name": "Installation", + "id": "installation", + "description": "Installing Nx", + "itemList": [ + { + "name": "Install Nx in a Non-Javascript Repo", + "id": "install-non-javascript", + "tags": ["installation"], + "file": "shared/recipes/installation/install-non-javascript" + }, + { + "name": "Update Your Global Nx Installation", + "id": "update-global-installation", + "tags": ["installation"], + "file": "shared/recipes/installation/update-global-installation" + } + ] + }, { "name": "Tasks & Caching", "id": "running-tasks", @@ -880,25 +899,6 @@ } ] }, - { - "name": "Installation", - "id": "installation", - "description": "Installing Nx", - "itemList": [ - { - "name": "Install Nx in a Non-Javascript Repo", - "id": "install-non-javascript", - "tags": ["installation"], - "file": "shared/recipes/installation/install-non-javascript" - }, - { - "name": "Update Your Global Nx Installation", - "id": "update-global-installation", - "tags": ["installation"], - "file": "shared/recipes/installation/update-global-installation" - } - ] - }, { "name": "Tips and tricks", "id": "tips-n-tricks", @@ -1008,42 +1008,6 @@ } ] }, - { - "name": "Troubleshooting", - "id": "troubleshooting", - "description": "Learn how to troubleshoot common problems.", - "itemList": [ - { - "name": "Resolve Circular Dependencies", - "id": "resolve-circular-dependencies", - "tags": ["explore-graph"], - "file": "shared/recipes/resolve-circular-dependencies" - }, - { - "name": "Troubleshooting Nx Install Issues", - "id": "troubleshoot-nx-install-issues", - "file": "shared/installation/troubleshoot-installation" - }, - { - "name": "Troubleshoot Cache Misses", - "id": "troubleshoot-cache-misses", - "tags": ["cache-task-results"], - "file": "shared/recipes/troubleshoot-cache-misses" - }, - { - "name": "Unknown Local Cache Error", - "id": "unknown-local-cache", - "tags": [], - "file": "shared/guides/unknown-local-cache" - }, - { - "name": "Profiling Build Performance", - "id": "performance-profiling", - "tags": ["environment-variables"], - "file": "shared/guides/performance-profiling" - } - ] - }, { "name": "Nx Console", "id": "nx-console", @@ -1337,6 +1301,43 @@ } ] }, + + { + "name": "Troubleshooting", + "id": "troubleshooting", + "description": "Learn how to troubleshoot common problems.", + "itemList": [ + { + "name": "Resolve Circular Dependencies", + "id": "resolve-circular-dependencies", + "tags": ["explore-graph"], + "file": "shared/recipes/resolve-circular-dependencies" + }, + { + "name": "Troubleshooting Nx Install Issues", + "id": "troubleshoot-nx-install-issues", + "file": "shared/installation/troubleshoot-installation" + }, + { + "name": "Troubleshoot Cache Misses", + "id": "troubleshoot-cache-misses", + "tags": ["cache-task-results"], + "file": "shared/recipes/troubleshoot-cache-misses" + }, + { + "name": "Unknown Local Cache Error", + "id": "unknown-local-cache", + "tags": [], + "file": "shared/guides/unknown-local-cache" + }, + { + "name": "Profiling Build Performance", + "id": "performance-profiling", + "tags": ["environment-variables"], + "file": "shared/guides/performance-profiling" + } + ] + }, { "name": "Deprecated", "id": "deprecated", @@ -1941,18 +1942,6 @@ } ] }, - { - "name": "Troubleshooting", - "id": "troubleshooting", - "description": "Learn how to solve common issues in Nx Cloud.", - "itemList": [ - { - "name": "CI Execution Failed", - "id": "ci-execution-failed", - "file": "nx-cloud/troubleshooting/ci-execution-failed" - } - ] - }, { "name": "Other", "id": "other", @@ -2004,6 +1993,18 @@ "file": "nx-cloud/reference/release-notes" } ] + }, + { + "name": "Troubleshooting", + "id": "troubleshooting", + "description": "Learn how to solve common issues in Nx Cloud.", + "itemList": [ + { + "name": "CI Execution Failed", + "id": "ci-execution-failed", + "file": "nx-cloud/troubleshooting/ci-execution-failed" + } + ] } ] }, diff --git a/docs/nx-cloud/concepts/cache-security.md b/docs/nx-cloud/concepts/cache-security.md index badfaf1fdb..0469f9c9bd 100644 --- a/docs/nx-cloud/concepts/cache-security.md +++ b/docs/nx-cloud/concepts/cache-security.md @@ -40,7 +40,7 @@ In order to guarantee that cache poisoning will never affect your end users, [sk ### Do Not Manually Share Your Local Cache -Nx implicitly trusts the local cache which is stored by default in the `.nx/cache` folder. You can change the location of that folder in the `nx.json` file, so it could be tempting to place it on a network drive and easily share your cache with everyone on the company network. However, by doing this you've voided the guarantee of immutability from your cache. If someone has direct access to the cached files, they could directly poison the cache. Nx will automatically detect if a cache entry has been created in your local cache using a different machine and warn you with an [Unknown Local Cache Error](/recipes/troubleshooting/unknown-local-cache). Instead, use Nx Cloud [remote caching](/ci/features/remote-cache). +Nx implicitly trusts the local cache which is stored by default in the `.nx/cache` folder. You can change the location of that folder in the `nx.json` file, so it could be tempting to place it on a network drive and easily share your cache with everyone on the company network. However, by doing this you've voided the guarantee of immutability from your cache. If someone has direct access to the cached files, they could directly poison the cache. Nx will automatically detect if a cache entry has been created in your local cache using a different machine and warn you with an [Unknown Local Cache Error](/troubleshooting/unknown-local-cache). Instead, use Nx Cloud [remote caching](/ci/features/remote-cache). ### Configure End to End Encryption diff --git a/docs/shared/guides/unknown-local-cache.md b/docs/shared/guides/unknown-local-cache.md index 2b1d89cd4c..6f026c6f5e 100644 --- a/docs/shared/guides/unknown-local-cache.md +++ b/docs/shared/guides/unknown-local-cache.md @@ -8,7 +8,7 @@ NX Invalid Cache Directory for Task "myapp:build" The local cache artifact in ".nx/cache/nx/786524780459028195" was not generated on this machine. As a result, the cache's content integrity cannot be confirmed, which may make cache restoration potentially unsafe. If your machine ID has changed since the artifact was cached, run "nx reset" to fix this issue. -Read about the error and how to address it here: https://nx.dev/recipes/troubleshooting/unknown-local-cache +Read about the error and how to address it here: https://nx.dev/troubleshooting/unknown-local-cache ``` ## Nx Tracks Cache Source diff --git a/docs/shared/migration/from-turborepo.md b/docs/shared/migration/from-turborepo.md index b905d9ebc6..6ab6a4ce69 100644 --- a/docs/shared/migration/from-turborepo.md +++ b/docs/shared/migration/from-turborepo.md @@ -150,7 +150,7 @@ For each `turbo.json` configuration property, the equivalent Nx property is list | `--preflight` | N/A | | `--trace` | N/A. [`--verbose`](/nx-api/nx/documents/run-many#verbose) for more logging. | | `--heap` | N/A. [`--verbose`](/nx-api/nx/documents/run-many#verbose) for more logging. | -| `--cpuprofile` | Use [`NX_PROFILE=profile.json`](/recipes/troubleshooting/performance-profiling). | +| `--cpuprofile` | Use [`NX_PROFILE=profile.json`](/troubleshooting/performance-profiling). | | `--verbosity` | Use [`--verbose`](/nx-api/nx/documents/run-many#verbose) | | `turbo gen` | [Use `nx generate`](/nx-api/nx/documents/generate) | | `turbo login` | No need. [Use `nx connect`](/nx-api/nx/documents/connect-to-nx-cloud) once to set up Nx Cloud. | diff --git a/docs/shared/recipes/console-troubleshooting.md b/docs/shared/recipes/console-troubleshooting.md index c69e2071b0..bb079c98c3 100644 --- a/docs/shared/recipes/console-troubleshooting.md +++ b/docs/shared/recipes/console-troubleshooting.md @@ -1,6 +1,6 @@ # Nx Console Troubleshooting -Often, issues with Nx Console are the result of underlying issues with Nx. Make sure to read the [Nx installation troubleshooting docs](recipes/troubleshooting/troubleshoot-nx-install-issues) for more help. +Often, issues with Nx Console are the result of underlying issues with Nx. Make sure to read the [Nx installation troubleshooting docs](/troubleshooting/troubleshoot-nx-install-issues) for more help. ## VSCode + nvm Issues diff --git a/docs/shared/reference/environment-variables.md b/docs/shared/reference/environment-variables.md index 52b958120f..a3479d838c 100644 --- a/docs/shared/reference/environment-variables.md +++ b/docs/shared/reference/environment-variables.md @@ -2,33 +2,33 @@ The following environment variables are ones that you can set to change the behavior of Nx in different environments. -| Property | Type | Description | -| -------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| NX_ADD_PLUGINS | boolean | If set to `false`, Nx will not add plugins to infer tasks. This is `true` by default. Workspaces created before Nx 18 will have this disabled via a migration for backwards compatibility | -| NX_BASE | string | The default base branch to use when calculating the affected projects. Can be overridden on the command line with `--base`. | -| NX_CACHE_DIRECTORY | string | The cache for task outputs is stored in `.nx/cache` by default. Set this variable to use a different directory. | -| NX_CACHE_PROJECT_GRAPH | boolean | If set to `false`, disables the project graph cache. Most useful when developing a plugin that modifies the project graph. | -| NX_DAEMON | boolean | If set to `false`, disables the Nx daemon process. Disable the daemon to print `console.log` statements in plugin code you are developing. | -| NX_DEFAULT_PROJECT | string | The default project used for commands which require a project. e.g. `nx build`, `nx g component`, etc. | -| NX_HEAD | string | The default head branch to use when calculating the affected projects. Can be overridden on the command line with `--head`. | -| NX_PERF_LOGGING | boolean | If set to `true`, will print debug information useful for for profiling executors and Nx itself | -| NX_PROFILE | string | Prepend `NX_PROFILE=profile.json` before running targets with Nx to generate a file that be [loaded in Chrome dev tools](/recipes/troubleshooting/performance-profiling) to visualize the performance of Nx across multiple processes. | -| NX_PROJECT_GRAPH_CACHE_DIRECTORY | string | The project graph cache is stored in `.nx/cache` by default. Set this variable to use a different directory. | -| NX_PROJECT_GRAPH_MAX_WORKERS | number | The number of workers to use when calculating the project graph. | -| NX_PARALLEL | number | The number of tasks Nx should run in parallel. Overrides any configured value inside nx.json | -| NX_RUNNER | string | The name of task runner from the config to use. Can be overridden on the command line with `--runner`. Not read if `NX_TASKS_RUNNER` is set. | -| NX_SKIP_NX_CACHE | boolean | Rerun the tasks even when the results are available in the cache | -| NX_TASKS_RUNNER | string | The name of task runner from the config to use. Can be overridden on the command line with `--runner`. Preferred over `NX_RUNNER`. | -| NX_TASKS_RUNNER_DYNAMIC_OUTPUT | boolean | If set to `false`, will use non-dynamic terminal output strategy (what you see in CI), even when you terminal can support the dynamic version | -| NX_VERBOSE_LOGGING | boolean | If set to `true`, will print debug information useful for troubleshooting | -| NX_DRY_RUN | boolean | If set to `true`, will perform a dry run of the generator. No files will be created and no packages will be installed. | -| NX_INTERACTIVE | boolean | If set to `true`, will allow Nx to prompt you in the terminal to answer some further questions when running generators. | -| NX_GENERATE_QUIET | boolean | If set to `true`, will prevent Nx logging file operations during generate | -| NX_PREFER_TS_NODE | boolean | If set to `true`, Nx will use `ts-node` for local execution of plugins even if `@swc-node/register` is installed. | -| NX_IGNORE_CYCLES | boolean | If set to `true`, Nx will ignore errors created by a task graph circular dependency. Can be overriden on the command line with `--nxIgnoreCycles` | -| NX_BATCH_MODE | boolean | If set to `true`, Nx will run task(s) in batches for executors which support batches. | -| NX_SKIP_LOG_GROUPING | boolean | If set to `true`, Nx will not group command's logs on CI. | -| NX_MIGRATE_CLI_VERSION | string | The version of Nx to use for running the `nx migrate` command. If not set, it defaults to `latest`. | +| Property | Type | Description | +| -------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| NX_ADD_PLUGINS | boolean | If set to `false`, Nx will not add plugins to infer tasks. This is `true` by default. Workspaces created before Nx 18 will have this disabled via a migration for backwards compatibility | +| NX_BASE | string | The default base branch to use when calculating the affected projects. Can be overridden on the command line with `--base`. | +| NX_CACHE_DIRECTORY | string | The cache for task outputs is stored in `.nx/cache` by default. Set this variable to use a different directory. | +| NX_CACHE_PROJECT_GRAPH | boolean | If set to `false`, disables the project graph cache. Most useful when developing a plugin that modifies the project graph. | +| NX_DAEMON | boolean | If set to `false`, disables the Nx daemon process. Disable the daemon to print `console.log` statements in plugin code you are developing. | +| NX_DEFAULT_PROJECT | string | The default project used for commands which require a project. e.g. `nx build`, `nx g component`, etc. | +| NX_HEAD | string | The default head branch to use when calculating the affected projects. Can be overridden on the command line with `--head`. | +| NX_PERF_LOGGING | boolean | If set to `true`, will print debug information useful for for profiling executors and Nx itself | +| NX_PROFILE | string | Prepend `NX_PROFILE=profile.json` before running targets with Nx to generate a file that be [loaded in Chrome dev tools](/troubleshooting/performance-profiling) to visualize the performance of Nx across multiple processes. | +| NX_PROJECT_GRAPH_CACHE_DIRECTORY | string | The project graph cache is stored in `.nx/cache` by default. Set this variable to use a different directory. | +| NX_PROJECT_GRAPH_MAX_WORKERS | number | The number of workers to use when calculating the project graph. | +| NX_PARALLEL | number | The number of tasks Nx should run in parallel. Overrides any configured value inside nx.json | +| NX_RUNNER | string | The name of task runner from the config to use. Can be overridden on the command line with `--runner`. Not read if `NX_TASKS_RUNNER` is set. | +| NX_SKIP_NX_CACHE | boolean | Rerun the tasks even when the results are available in the cache | +| NX_TASKS_RUNNER | string | The name of task runner from the config to use. Can be overridden on the command line with `--runner`. Preferred over `NX_RUNNER`. | +| NX_TASKS_RUNNER_DYNAMIC_OUTPUT | boolean | If set to `false`, will use non-dynamic terminal output strategy (what you see in CI), even when you terminal can support the dynamic version | +| NX_VERBOSE_LOGGING | boolean | If set to `true`, will print debug information useful for troubleshooting | +| NX_DRY_RUN | boolean | If set to `true`, will perform a dry run of the generator. No files will be created and no packages will be installed. | +| NX_INTERACTIVE | boolean | If set to `true`, will allow Nx to prompt you in the terminal to answer some further questions when running generators. | +| NX_GENERATE_QUIET | boolean | If set to `true`, will prevent Nx logging file operations during generate | +| NX_PREFER_TS_NODE | boolean | If set to `true`, Nx will use `ts-node` for local execution of plugins even if `@swc-node/register` is installed. | +| NX_IGNORE_CYCLES | boolean | If set to `true`, Nx will ignore errors created by a task graph circular dependency. Can be overriden on the command line with `--nxIgnoreCycles` | +| NX_BATCH_MODE | boolean | If set to `true`, Nx will run task(s) in batches for executors which support batches. | +| NX_SKIP_LOG_GROUPING | boolean | If set to `true`, Nx will not group command's logs on CI. | +| NX_MIGRATE_CLI_VERSION | string | The version of Nx to use for running the `nx migrate` command. If not set, it defaults to `latest`. | Nx will set the following environment variables so they can be accessible within the process even outside of executors and generators. diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index a6ab6381fd..62d5ea772f 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -60,6 +60,9 @@ - [Buildable and Publishable Libraries](/concepts/more-concepts/buildable-and-publishable-libraries) - [How the Project Graph is Built](/concepts/more-concepts/how-project-graph-is-built) - [Recipes](/recipes) + - [Installation](/recipes/installation) + - [Install Nx in a Non-Javascript Repo](/recipes/installation/install-non-javascript) + - [Update Your Global Nx Installation](/recipes/installation/update-global-installation) - [Tasks & Caching](/recipes/running-tasks) - [Configure Inputs for Task Caching](/recipes/running-tasks/configure-inputs) - [Configure Outputs for Task Caching](/recipes/running-tasks/configure-outputs) @@ -136,9 +139,6 @@ - [Tag in Multiple Dimensions](/recipes/enforce-module-boundaries/tag-multiple-dimensions) - [Ban External Imports](/recipes/enforce-module-boundaries/ban-external-imports) - [Tags Allow List](/recipes/enforce-module-boundaries/tags-allow-list) - - [Installation](/recipes/installation) - - [Install Nx in a Non-Javascript Repo](/recipes/installation/install-non-javascript) - - [Update Your Global Nx Installation](/recipes/installation/update-global-installation) - [Tips and tricks](/recipes/tips-n-tricks) - [Add a Package-based Project in an Integrated Repo](/recipes/tips-n-tricks/package-based-in-integrated) - [Add an Integrated Project in a Package-based Repo](/recipes/tips-n-tricks/integrated-in-package-based) @@ -158,12 +158,6 @@ - [Altering Migration Process](/recipes/tips-n-tricks/advanced-update) - [Using Yarn PnP](/recipes/tips-n-tricks/yarn-pnp) - [Switching to ESLint's flat config format](/recipes/tips-n-tricks/flat-config) - - [Troubleshooting](/recipes/troubleshooting) - - [Resolve Circular Dependencies](/recipes/troubleshooting/resolve-circular-dependencies) - - [Troubleshooting Nx Install Issues](/recipes/troubleshooting/troubleshoot-nx-install-issues) - - [Troubleshoot Cache Misses](/recipes/troubleshooting/troubleshoot-cache-misses) - - [Unknown Local Cache Error](/recipes/troubleshooting/unknown-local-cache) - - [Profiling Build Performance](/recipes/troubleshooting/performance-profiling) - [Nx Console](/recipes/nx-console) - [Telemetry](/recipes/nx-console/console-telemetry) - [Project Details View](/recipes/nx-console/console-project-details) @@ -211,6 +205,12 @@ - [.nxignore](/reference/nxignore) - [Environment Variables](/reference/environment-variables) - [Glossary](/reference/glossary) + - [Troubleshooting](/troubleshooting) + - [Resolve Circular Dependencies](/troubleshooting/resolve-circular-dependencies) + - [Troubleshooting Nx Install Issues](/troubleshooting/troubleshoot-nx-install-issues) + - [Troubleshoot Cache Misses](/troubleshooting/troubleshoot-cache-misses) + - [Unknown Local Cache Error](/troubleshooting/unknown-local-cache) + - [Profiling Build Performance](/troubleshooting/performance-profiling) - [Deprecated](/deprecated) - [workspace.json](/deprecated/workspace-json) - [workspace-lint](/deprecated/workspace-lint) @@ -310,8 +310,6 @@ - [Bitbucket Pipelines Custom DTE](/ci/recipes/enterprise/dte/bitbucket-dte) - [GitLab Custom DTE](/ci/recipes/enterprise/dte/gitlab-dte) - [Jenkins Custom DTE](/ci/recipes/enterprise/dte/jenkins-dte) - - [Troubleshooting](/ci/recipes/troubleshooting) - - [CI Execution Failed](/ci/recipes/troubleshooting/ci-execution-failed) - [Other](/ci/recipes/other) - [Record Non-Nx Commands](/ci/recipes/other/record-commands) - [Prepare applications for deployment via CI](/ci/recipes/other/ci-deployment) @@ -321,6 +319,8 @@ - [Launch Templates](/ci/reference/launch-templates) - [Environment Variables](/ci/reference/env-vars) - [Release Notes](/ci/reference/release-notes) + - [Troubleshooting](/ci/troubleshooting) + - [CI Execution Failed](/ci/troubleshooting/ci-execution-failed) - Nx-api - [angular](/nx-api/angular) diff --git a/nx-dev/data-access-menu/src/lib/menu.utils.ts b/nx-dev/data-access-menu/src/lib/menu.utils.ts index 7db23fef83..0d17678462 100644 --- a/nx-dev/data-access-menu/src/lib/menu.utils.ts +++ b/nx-dev/data-access-menu/src/lib/menu.utils.ts @@ -13,7 +13,8 @@ export function getBasicNxSection(items: MenuItem[]): MenuSection { m.id === 'concepts' || m.id === 'recipes' || m.id === 'showcase' || - m.id === 'reference' + m.id === 'reference' || + m.id === 'troubleshooting' ) .map((m) => { return { @@ -84,7 +85,8 @@ export function getBasicNxCloudSection(items: MenuItem[]): MenuSection { m.id === 'features' || m.id === 'concepts' || m.id === 'recipes' || - m.id === 'reference' + m.id === 'reference' || + m.id === 'troubleshooting' ) .map((m) => { return { diff --git a/nx-dev/nx-dev/redirect-rules.js b/nx-dev/nx-dev/redirect-rules.js index 7741a69700..e795b133ac 100644 --- a/nx-dev/nx-dev/redirect-rules.js +++ b/nx-dev/nx-dev/redirect-rules.js @@ -943,17 +943,6 @@ const latestRecipesRefactoring = { '/recipes/database/serverless-fastify-planetscale': '/showcase/example-repos/serverless-fastify-planetscale', '/recipes/example-repos/:path*': '/showcase/example-repos/:path*', - // troubleshooting - '/recipes/other/resolve-circular-dependencies': - '/recipes/troubleshooting/resolve-circular-dependencies', - '/recipes/ci/troubleshoot-nx-install-issues': - '/recipes/troubleshooting/troubleshoot-nx-install-issues', - '/recipes/other/troubleshoot-cache-misses': - '/recipes/troubleshooting/troubleshoot-cache-misses', - '/recipes/other/unknown-local-cache': - '/recipes/troubleshooting/unknown-local-cache', - '/recipes/other/performance-profiling': - '/recipes/troubleshooting/performance-profiling', // tips and tricks '/recipes/environment-variables/define-environment-variables': '/recipes/tips-n-tricks/define-environment-variables', @@ -1031,6 +1020,22 @@ const eslintRename = { '/packages/linter': '/packages/eslint', }; +// move troubleshooting out of recipes +const troubleshootingOutOfRecipes = { + '/recipes/troubleshooting': '/troubleshooting', + '/recipes/troubleshooting/:path*': '/troubleshooting/:path*', + '/ci/recipes/troubleshooting/:path*': '/ci/troubleshooting/:path*', + '/recipes/other/resolve-circular-dependencies': + '/troubleshooting/resolve-circular-dependencies', + '/recipes/ci/troubleshoot-nx-install-issues': + '/troubleshooting/troubleshoot-nx-install-issues', + '/recipes/other/troubleshoot-cache-misses': + '/troubleshooting/troubleshoot-cache-misses', + '/recipes/other/unknown-local-cache': '/troubleshooting/unknown-local-cache', + '/recipes/other/performance-profiling': + '/troubleshooting/performance-profiling', +}; + /** * Public export API */ @@ -1058,4 +1063,5 @@ module.exports = { coreFeatureRefactoring: coreFeatureAndConceptsRefactoring, aiChat, eslintRename, + troubleshootingOutOfRecipes, }; diff --git a/packages/nx/src/native/assert-supported-platform.ts b/packages/nx/src/native/assert-supported-platform.ts index 744ca3d5c6..da988c05b6 100644 --- a/packages/nx/src/native/assert-supported-platform.ts +++ b/packages/nx/src/native/assert-supported-platform.ts @@ -28,7 +28,7 @@ export function assertSupportedPlatform() { } bodyLines.push( - 'For more information please see https://nx.dev/recipes/troubleshooting/troubleshoot-nx-install-issues' + 'For more information please see https://nx.dev/troubleshooting/troubleshoot-nx-install-issues' ); output.error({ diff --git a/packages/nx/src/tasks-runner/cache.ts b/packages/nx/src/tasks-runner/cache.ts index 648ca6cb4a..894d392e1d 100644 --- a/packages/nx/src/tasks-runner/cache.ts +++ b/packages/nx/src/tasks-runner/cache.ts @@ -255,7 +255,7 @@ export class Cache { `The local cache artifact in "${td}" was not generated on this machine.`, `As a result, the cache's content integrity cannot be confirmed, which may make cache restoration potentially unsafe.`, `If your machine ID has changed since the artifact was cached, run "nx reset" to fix this issue.`, - `Read about the error and how to address it here: https://nx.dev/recipes/troubleshooting/unknown-local-cache`, + `Read about the error and how to address it here: https://nx.dev/troubleshooting/unknown-local-cache`, ``, ].join('\n'); throw new Error(error);