docs(core): nx command related docs (#28891)

Adds related documents to Nx commands API reference pages
This commit is contained in:
Isaac Mann 2024-11-13 12:07:00 -05:00 committed by GitHub
parent 7f4fc50dfb
commit 0983ba52bc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 247 additions and 55 deletions

View File

@ -600,7 +600,7 @@
"itemList": [],
"isExternal": false,
"path": "/ci/recipes/security/personal-access-tokens",
"tags": []
"tags": ["login"]
},
{
"id": "encryption",
@ -1074,7 +1074,7 @@
"itemList": [],
"isExternal": false,
"path": "/ci/recipes/security/personal-access-tokens",
"tags": []
"tags": ["login"]
},
{
"id": "encryption",
@ -1123,7 +1123,7 @@
"itemList": [],
"isExternal": false,
"path": "/ci/recipes/security/personal-access-tokens",
"tags": []
"tags": ["login"]
},
"/ci/recipes/security/encryption": {
"id": "encryption",

View File

@ -160,7 +160,7 @@
"itemList": [],
"isExternal": false,
"path": "/extending-nx/recipes/create-sync-generator",
"tags": ["generate-code"]
"tags": ["generate-code", "sync"]
},
{
"id": "migration-generators",
@ -308,7 +308,7 @@
"itemList": [],
"isExternal": false,
"path": "/extending-nx/recipes/create-sync-generator",
"tags": ["generate-code"]
"tags": ["generate-code", "sync"]
},
"/extending-nx/recipes/migration-generators": {
"id": "migration-generators",

View File

@ -1748,7 +1748,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/create-nx-workspace",
"tags": [],
"tags": ["installation"],
"originalFilePath": "generated/cli/create-nx-workspace"
},
"/nx-api/nx/documents/init": {
@ -1759,7 +1759,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/init",
"tags": [],
"tags": ["init"],
"originalFilePath": "generated/cli/init"
},
"/nx-api/nx/documents/generate": {
@ -1792,7 +1792,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/daemon",
"tags": [],
"tags": ["daemon"],
"originalFilePath": "generated/cli/daemon"
},
"/nx-api/nx/documents/dep-graph": {
@ -1924,7 +1924,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/sync",
"tags": [],
"tags": ["sync"],
"originalFilePath": "generated/cli/sync"
},
"/nx-api/nx/documents/sync-check": {
@ -1935,7 +1935,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/sync-check",
"tags": [],
"tags": ["sync"],
"originalFilePath": "generated/cli/sync-check"
},
"/nx-api/nx/documents/import": {
@ -1946,7 +1946,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/import",
"tags": [],
"tags": ["import"],
"originalFilePath": "generated/cli/import"
},
"/nx-api/nx/documents/exec": {
@ -1957,7 +1957,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/exec",
"tags": [],
"tags": ["exec"],
"originalFilePath": "generated/cli/exec"
},
"/nx-api/nx/documents/watch": {
@ -1979,7 +1979,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/show",
"tags": [],
"tags": ["explore-graph"],
"originalFilePath": "generated/cli/show"
},
"/nx-api/nx/documents/view-logs": {
@ -2012,7 +2012,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/add",
"tags": [],
"tags": ["add"],
"originalFilePath": "generated/cli/add"
},
"/nx-api/nx/documents/login": {
@ -2023,7 +2023,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/login",
"tags": [],
"tags": ["login"],
"originalFilePath": "generated/cli/login"
},
"/nx-api/nx/documents/logout": {
@ -2034,7 +2034,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/logout",
"tags": [],
"tags": ["login"],
"originalFilePath": "generated/cli/logout"
}
},

View File

@ -791,7 +791,12 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-plugins",
"tags": ["generate-code", "create-your-own-plugin", "inferred-tasks"]
"tags": [
"add",
"generate-code",
"create-your-own-plugin",
"inferred-tasks"
]
},
{
"id": "inferred-tasks",
@ -835,7 +840,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-daemon",
"tags": []
"tags": ["daemon"]
},
{
"id": "sync-generators",
@ -846,7 +851,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/sync-generators",
"tags": []
"tags": ["sync"]
},
{
"id": "turbo-and-nx",
@ -1073,7 +1078,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-plugins",
"tags": ["generate-code", "create-your-own-plugin", "inferred-tasks"]
"tags": ["add", "generate-code", "create-your-own-plugin", "inferred-tasks"]
},
"/concepts/inferred-tasks": {
"id": "inferred-tasks",
@ -1117,7 +1122,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-daemon",
"tags": []
"tags": ["daemon"]
},
"/concepts/sync-generators": {
"id": "sync-generators",
@ -1128,7 +1133,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/sync-generators",
"tags": []
"tags": ["sync"]
},
"/concepts/turbo-and-nx": {
"id": "turbo-and-nx",
@ -1563,7 +1568,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/running-tasks/root-level-scripts",
"tags": ["run-tasks"]
"tags": ["run-tasks", "exec"]
},
{
"id": "workspace-watching",
@ -1641,7 +1646,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-monorepo",
"tags": []
"tags": ["init"]
},
{
"id": "from-turborepo",
@ -1663,7 +1668,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-existing-project",
"tags": []
"tags": ["init"]
},
{
"id": "import-project",
@ -1674,7 +1679,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/import-project",
"tags": []
"tags": ["import"]
},
{
"id": "preserving-git-histories",
@ -2104,7 +2109,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
{
"id": "angular-multiple",
@ -2679,7 +2684,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"]
"tags": ["automate-updating-dependencies", "add"]
},
{
"id": "define-environment-variables",
@ -2939,7 +2944,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/running-tasks/root-level-scripts",
"tags": ["run-tasks"]
"tags": ["run-tasks", "exec"]
},
{
"id": "workspace-watching",
@ -3076,7 +3081,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/running-tasks/root-level-scripts",
"tags": ["run-tasks"]
"tags": ["run-tasks", "exec"]
},
"/recipes/running-tasks/workspace-watching": {
"id": "workspace-watching",
@ -3149,7 +3154,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-monorepo",
"tags": []
"tags": ["init"]
},
{
"id": "from-turborepo",
@ -3171,7 +3176,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-existing-project",
"tags": []
"tags": ["init"]
},
{
"id": "import-project",
@ -3182,7 +3187,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/import-project",
"tags": []
"tags": ["import"]
},
{
"id": "preserving-git-histories",
@ -3220,7 +3225,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-monorepo",
"tags": []
"tags": ["init"]
},
"/recipes/adopting-nx/from-turborepo": {
"id": "from-turborepo",
@ -3242,7 +3247,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-existing-project",
"tags": []
"tags": ["init"]
},
"/recipes/adopting-nx/import-project": {
"id": "import-project",
@ -3253,7 +3258,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/import-project",
"tags": []
"tags": ["import"]
},
"/recipes/adopting-nx/preserving-git-histories": {
"id": "preserving-git-histories",
@ -4008,7 +4013,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
{
"id": "angular-multiple",
@ -4102,7 +4107,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
{
"id": "angular-multiple",
@ -4129,7 +4134,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
"/recipes/angular/migration/angular-multiple": {
"id": "angular-multiple",
@ -5024,7 +5029,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"]
"tags": ["automate-updating-dependencies", "add"]
},
{
"id": "define-environment-variables",
@ -5205,7 +5210,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"]
"tags": ["automate-updating-dependencies", "add"]
},
"/recipes/tips-n-tricks/define-environment-variables": {
"id": "define-environment-variables",

View File

@ -278,6 +278,13 @@
"id": "dep-graph",
"name": "graph",
"path": "/nx-api/nx/documents/dep-graph"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/show",
"id": "show",
"name": "show",
"path": "/nx-api/nx/documents/show"
}
],
"generate-code": [
@ -628,6 +635,29 @@
"path": "/extending-nx/recipes/project-graph-plugins"
}
],
"add": [
{
"description": "",
"file": "shared/concepts/nx-plugins",
"id": "nx-plugins",
"name": "What Are Nx Plugins",
"path": "/concepts/nx-plugins"
},
{
"description": "",
"file": "shared/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"id": "keep-nx-versions-in-sync",
"name": "Keep Nx Versions in Sync",
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/add",
"id": "add",
"name": "add",
"path": "/nx-api/nx/documents/add"
}
],
"create-your-own-plugin": [
{
"description": "",
@ -679,6 +709,52 @@
"path": "/nx-api/angular/documents/nx-devkit-angular-devkit"
}
],
"daemon": [
{
"description": "",
"file": "shared/concepts/daemon",
"id": "nx-daemon",
"name": "Nx Daemon",
"path": "/concepts/nx-daemon"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/daemon",
"id": "daemon",
"name": "daemon",
"path": "/nx-api/nx/documents/daemon"
}
],
"sync": [
{
"description": "",
"file": "shared/concepts/sync-generators",
"id": "sync-generators",
"name": "Sync Generators",
"path": "/concepts/sync-generators"
},
{
"description": "",
"file": "shared/recipes/generators/create-sync-generator",
"id": "create-sync-generator",
"name": "Create a Sync Generator",
"path": "/extending-nx/recipes/create-sync-generator"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/sync",
"id": "sync",
"name": "sync",
"path": "/nx-api/nx/documents/sync"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/sync-check",
"id": "sync-check",
"name": "sync:check",
"path": "/nx-api/nx/documents/sync-check"
}
],
"module-federation": [
{
"description": "",
@ -811,6 +887,29 @@
"id": "activate-powerpack",
"name": "Activate Powerpack",
"path": "/nx-enterprise/activate-powerpack"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/create-nx-workspace",
"id": "create-nx-workspace",
"name": "create-nx-workspace",
"path": "/nx-api/nx/documents/create-nx-workspace"
}
],
"exec": [
{
"description": "",
"file": "shared/recipes/running-tasks/root-level-scripts",
"id": "root-level-scripts",
"name": "Run Root-Level NPM Scripts with Nx",
"path": "/recipes/running-tasks/root-level-scripts"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/exec",
"id": "exec",
"name": "exec",
"path": "/nx-api/nx/documents/exec"
}
],
"workspace-watching": [
@ -829,6 +928,52 @@
"path": "/nx-api/nx/documents/watch"
}
],
"init": [
{
"description": "",
"file": "shared/migration/adding-to-monorepo",
"id": "adding-to-monorepo",
"name": "NPM/Yarn/PNPM workspaces",
"path": "/recipes/adopting-nx/adding-to-monorepo"
},
{
"description": "",
"file": "shared/migration/adding-to-existing-project",
"id": "adding-to-existing-project",
"name": "Add to any Project",
"path": "/recipes/adopting-nx/adding-to-existing-project"
},
{
"description": "",
"file": "shared/migration/migration-angular",
"id": "angular",
"name": "Migrating from Angular CLI",
"path": "/recipes/angular/migration/angular"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/init",
"id": "init",
"name": "init",
"path": "/nx-api/nx/documents/init"
}
],
"import": [
{
"description": "",
"file": "shared/migration/import-project",
"id": "import-project",
"name": "Import an Existing Project into an Nx Workspace",
"path": "/recipes/adopting-nx/import-project"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/import",
"id": "import",
"name": "import",
"path": "/nx-api/nx/documents/import"
}
],
"environment-variables": [
{
"description": "",
@ -1195,6 +1340,29 @@
"path": "/ci/features/remote-cache"
}
],
"login": [
{
"description": "",
"file": "nx-cloud/recipes/personal-access-tokens",
"id": "personal-access-tokens",
"name": "Personal Access Tokens",
"path": "/ci/recipes/security/personal-access-tokens"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/login",
"id": "login",
"name": "login",
"path": "/nx-api/nx/documents/login"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/logout",
"id": "logout",
"name": "logout",
"path": "/nx-api/nx/documents/logout"
}
],
"single-tenant": [
{
"description": "",

View File

@ -1726,7 +1726,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/create-nx-workspace",
"tags": [],
"tags": ["installation"],
"originalFilePath": "generated/cli/create-nx-workspace"
},
{
@ -1737,7 +1737,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/init",
"tags": [],
"tags": ["init"],
"originalFilePath": "generated/cli/init"
},
{
@ -1770,7 +1770,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/daemon",
"tags": [],
"tags": ["daemon"],
"originalFilePath": "generated/cli/daemon"
},
{
@ -1902,7 +1902,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/sync",
"tags": [],
"tags": ["sync"],
"originalFilePath": "generated/cli/sync"
},
{
@ -1913,7 +1913,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/sync-check",
"tags": [],
"tags": ["sync"],
"originalFilePath": "generated/cli/sync-check"
},
{
@ -1924,7 +1924,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/import",
"tags": [],
"tags": ["import"],
"originalFilePath": "generated/cli/import"
},
{
@ -1935,7 +1935,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/exec",
"tags": [],
"tags": ["exec"],
"originalFilePath": "generated/cli/exec"
},
{
@ -1957,7 +1957,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/show",
"tags": [],
"tags": ["explore-graph"],
"originalFilePath": "generated/cli/show"
},
{
@ -1990,7 +1990,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/add",
"tags": [],
"tags": ["add"],
"originalFilePath": "generated/cli/add"
},
{
@ -2001,7 +2001,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/login",
"tags": [],
"tags": ["login"],
"originalFilePath": "generated/cli/login"
},
{
@ -2012,7 +2012,7 @@
"itemList": [],
"isExternal": false,
"path": "nx/documents/logout",
"tags": [],
"tags": ["login"],
"originalFilePath": "generated/cli/logout"
}
],

View File

@ -210,6 +210,7 @@
{
"name": "What Are Nx Plugins",
"tags": [
"add",
"generate-code",
"create-your-own-plugin",
"inferred-tasks"
@ -238,11 +239,13 @@
{
"name": "Nx Daemon",
"id": "nx-daemon",
"tags": ["daemon"],
"file": "shared/concepts/daemon"
},
{
"name": "Sync Generators",
"id": "sync-generators",
"tags": ["sync"],
"file": "shared/concepts/sync-generators"
},
{
@ -406,7 +409,7 @@
{
"name": "Run Root-Level NPM Scripts with Nx",
"id": "root-level-scripts",
"tags": ["run-tasks"],
"tags": ["run-tasks", "exec"],
"file": "shared/recipes/running-tasks/root-level-scripts"
},
{
@ -447,6 +450,7 @@
{
"name": "NPM/Yarn/PNPM workspaces",
"id": "adding-to-monorepo",
"tags": ["init"],
"file": "shared/migration/adding-to-monorepo"
},
{
@ -457,11 +461,13 @@
{
"name": "Add to any Project",
"id": "adding-to-existing-project",
"tags": ["init"],
"file": "shared/migration/adding-to-existing-project"
},
{
"name": "Import an Existing Project into an Nx Workspace",
"id": "import-project",
"tags": ["import"],
"file": "shared/migration/import-project"
},
{
@ -690,6 +696,7 @@
{
"name": "Migrating from Angular CLI",
"id": "angular",
"tags": ["init"],
"file": "shared/migration/migration-angular"
},
{
@ -1011,7 +1018,7 @@
{
"name": "Keep Nx Versions in Sync",
"id": "keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"],
"tags": ["automate-updating-dependencies", "add"],
"file": "shared/recipes/tips-n-tricks/keep-nx-versions-in-sync"
},
{
@ -1576,7 +1583,7 @@
{
"name": "Create a Sync Generator",
"id": "create-sync-generator",
"tags": ["generate-code"],
"tags": ["generate-code", "sync"],
"file": "shared/recipes/generators/create-sync-generator"
},
{
@ -1825,6 +1832,7 @@
{
"name": "Personal Access Tokens",
"id": "personal-access-tokens",
"tags": ["login"],
"file": "nx-cloud/recipes/personal-access-tokens"
},
{
@ -2039,11 +2047,13 @@
{
"name": "create-nx-workspace",
"id": "create-nx-workspace",
"tags": ["installation"],
"file": "generated/cli/create-nx-workspace"
},
{
"name": "init",
"id": "init",
"tags": ["init"],
"file": "generated/cli/init"
},
{
@ -2061,6 +2071,7 @@
{
"name": "daemon",
"id": "daemon",
"tags": ["daemon"],
"file": "generated/cli/daemon"
},
{
@ -2129,21 +2140,25 @@
{
"name": "sync",
"id": "sync",
"tags": ["sync"],
"file": "generated/cli/sync"
},
{
"name": "sync:check",
"id": "sync-check",
"tags": ["sync"],
"file": "generated/cli/sync-check"
},
{
"name": "import",
"id": "import",
"tags": ["import"],
"file": "generated/cli/import"
},
{
"name": "exec",
"id": "exec",
"tags": ["exec"],
"file": "generated/cli/exec"
},
{
@ -2155,6 +2170,7 @@
{
"name": "show",
"id": "show",
"tags": ["explore-graph"],
"file": "generated/cli/show"
},
{
@ -2171,16 +2187,19 @@
{
"name": "add",
"id": "add",
"tags": ["add"],
"file": "generated/cli/add"
},
{
"name": "login",
"id": "login",
"tags": ["login"],
"file": "generated/cli/login"
},
{
"name": "logout",
"id": "logout",
"tags": ["login"],
"file": "generated/cli/logout"
}
]