Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): improve core features and concepts #19014

Merged
merged 3 commits into from
Oct 19, 2023
Merged

docs(core): improve core features and concepts #19014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d5a311
docs(core): improve core features and concepts
juristr Sep 5, 2023
3299ad1
docs(core): move task related recipes into task section
juristr Oct 18, 2023
f3be6c3
docs(core): move global & nx wrapper to installation page
juristr Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
394 changes: 194 additions & 200 deletions docs/generated/manifests/menus.json
View file
Open in desktop

Large diffs are not rendered by default.

508 changes: 250 additions & 258 deletions docs/generated/manifests/nx.json
View file
Open in desktop

Large diffs are not rendered by default.

118 changes: 73 additions & 45 deletions docs/generated/manifests/tags.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,50 @@
"description": "",
"file": "shared/concepts/task-pipeline-configuration",
"id": "task-pipeline-configuration",
"name": "Task Pipeline Configuration",
"name": "What is a Task Pipeline",
"path": "/concepts/task-pipeline-configuration"
},
{
"description": "",
"file": "shared/using-nx/affected",
"id": "affected",
"name": "Affected",
"name": "How Affected Works",
"path": "/concepts/affected"
},
{
"description": "",
"file": "shared/recipes/root-level-scripts",
"file": "shared/recipes/running-tasks/customizing-inputs",
"id": "customizing-inputs",
"name": "Fine-tuning Caching with Inputs",
"path": "/recipes/running-tasks/customizing-inputs"
},
{
"description": "",
"file": "shared/recipes/running-tasks/defining-task-pipeline",
"id": "defining-task-pipeline",
"name": "Defining a Task Pipeline",
"path": "/recipes/running-tasks/defining-task-pipeline"
},
{
"description": "",
"file": "shared/recipes/running-tasks/running-custom-commands",
"id": "run-commands-executor",
"name": "Running Custom Commands",
"path": "/recipes/running-tasks/run-commands-executor"
},
{
"description": "",
"file": "shared/recipes/running-tasks/root-level-scripts",
"id": "root-level-scripts",
"name": "Run Root-Level NPM Scripts with Nx",
"path": "/recipes/tips-n-tricks/root-level-scripts"
"path": "/recipes/running-tasks/root-level-scripts"
},
{
"description": "",
"file": "shared/recipes/running-tasks/workspace-watching",
"id": "workspace-watching",
"name": "Workspace Watching",
"path": "/recipes/running-tasks/workspace-watching"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
Expand All @@ -51,6 +79,13 @@
}
],
"cache-task-results": [
{
"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",
"path": "/core-features/run-tasks"
},
{
"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",
Expand All @@ -67,17 +102,10 @@
},
{
"description": "",
"file": "shared/concepts/task-pipeline-configuration",
"id": "task-pipeline-configuration",
"name": "Task Pipeline Configuration",
"path": "/concepts/task-pipeline-configuration"
},
{
"description": "",
"file": "shared/concepts/customizing-inputs",
"file": "shared/recipes/running-tasks/customizing-inputs",
"id": "customizing-inputs",
"name": "Customizing Inputs",
"path": "/concepts/more-concepts/customizing-inputs"
"name": "Fine-tuning Caching with Inputs",
"path": "/recipes/running-tasks/customizing-inputs"
},
{
"description": "",
Expand Down Expand Up @@ -433,7 +461,7 @@
"description": "",
"file": "shared/concepts/task-pipeline-configuration",
"id": "task-pipeline-configuration",
"name": "Task Pipeline Configuration",
"name": "What is a Task Pipeline",
"path": "/concepts/task-pipeline-configuration"
},
{
Expand All @@ -450,6 +478,13 @@
"name": "Incremental Builds",
"path": "/concepts/more-concepts/incremental-builds"
},
{
"description": "",
"file": "shared/recipes/running-tasks/running-custom-commands",
"id": "run-commands-executor",
"name": "Running Custom Commands",
"path": "/recipes/running-tasks/run-commands-executor"
},
{
"description": "",
"file": "shared/recipes/module-federation-with-ssr",
Expand All @@ -471,13 +506,6 @@
"name": "Advanced Micro Frontends with Angular using Dynamic Federation",
"path": "/recipes/angular/dynamic-module-federation-with-angular"
},
{
"description": "",
"file": "shared/running-custom-commands",
"id": "run-commands-executor",
"name": "Running Custom Commands",
"path": "/recipes/tips-n-tricks/run-commands-executor"
},
{
"description": "",
"file": "shared/guides/performance-profiling",
Expand Down Expand Up @@ -594,19 +622,19 @@
}
],
"intro": [
{
"description": "",
"file": "shared/concepts/integrated-vs-package-based",
"id": "integrated-vs-package-based",
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
"path": "/concepts/integrated-vs-package-based"
},
{
"description": "",
"file": "shared/mental-model",
"id": "mental-model",
"name": "Mental Model",
"path": "/concepts/mental-model"
},
{
"description": "",
"file": "shared/concepts/integrated-vs-package-based",
"id": "integrated-vs-package-based",
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
"path": "/concepts/integrated-vs-package-based"
}
],
"repository-types": [
Expand Down Expand Up @@ -745,6 +773,22 @@
"path": "/extending-nx/recipes/project-graph-plugins"
}
],
"workspace-watching": [
{
"description": "",
"file": "shared/recipes/running-tasks/workspace-watching",
"id": "workspace-watching",
"name": "Workspace Watching",
"path": "/recipes/running-tasks/workspace-watching"
},
{
"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/watch",
"id": "watch",
"name": "watch",
"path": "/nx-api/nx/documents/watch"
}
],
"environment-variables": [
{
"description": "",
Expand Down Expand Up @@ -1004,22 +1048,6 @@
"path": "/recipes/ci/ci-deployment"
}
],
"workspace-watching": [
{
"description": "",
"file": "shared/recipes/workspace-watching",
"id": "workspace-watching",
"name": "Workspace Watching",
"path": "/recipes/tips-n-tricks/workspace-watching"
},
{
"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/watch",
"id": "watch",
"name": "watch",
"path": "/nx-api/nx/documents/watch"
}
],
"yarn": [
{
"description": "",
Expand Down
115 changes: 59 additions & 56 deletions docs/map.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
{
"name": "Run Tasks",
"description": "Learn about the various ways you can use Nx to run tasks in your workspace.",
"tags": ["run-tasks"],
"tags": ["run-tasks", "cache-task-results"],
"id": "run-tasks",
"file": "shared/core-features/run-tasks"
},
Expand Down Expand Up @@ -265,48 +265,48 @@
"id": "concepts",
"description": "Learn about all the different concepts Nx uses to manage your tasks and enhance your productivity.",
"itemList": [
{
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
"tags": ["intro", "repository-types"],
"id": "integrated-vs-package-based",
"file": "shared/concepts/integrated-vs-package-based"
},
{
"name": "Mental Model",
"tags": ["intro"],
"id": "mental-model",
"file": "shared/mental-model"
},
{
"name": "Types of Configuration",
"tags": [],
"id": "types-of-configuration",
"file": "shared/concepts/types-of-configuration"
},
{
"name": "How Caching Works",
"tags": ["cache-task-results"],
"id": "how-caching-works",
"file": "shared/concepts/how-caching-works"
},
{
"name": "Types of Configuration",
"tags": [],
"id": "types-of-configuration",
"file": "shared/concepts/types-of-configuration"
},
{
"name": "Improve Worst Case CI Times",
"tags": ["distribute-task-execution"],
"id": "dte",
"file": "shared/concepts/improve-worst-case-ci-times"
},
{
"name": "Task Pipeline Configuration",
"tags": ["run-tasks", "cache-task-results", "use-task-executors"],
"name": "What is a Task Pipeline",
"tags": ["run-tasks", "use-task-executors"],
"id": "task-pipeline-configuration",
"file": "shared/concepts/task-pipeline-configuration"
},
{
"name": "Affected",
"name": "How Affected Works",
"tags": ["run-tasks"],
"id": "affected",
"file": "shared/using-nx/affected"
},
{
"name": "Integrated Repos vs. Package-Based Repos vs. Standalone Apps",
"tags": ["intro", "repository-types"],
"id": "integrated-vs-package-based",
"file": "shared/concepts/integrated-vs-package-based"
},
{
"name": "Module Federation",
"id": "module-federation",
Expand Down Expand Up @@ -341,12 +341,6 @@
"id": "more-concepts",
"description": "Get deeper into how Nx works and its different aspects.",
"itemList": [
{
"name": "Customizing Inputs",
"id": "customizing-inputs",
"tags": ["cache-task-results"],
"file": "shared/concepts/customizing-inputs"
},
{
"name": "Incremental Builds",
"id": "incremental-builds",
Expand Down Expand Up @@ -440,16 +434,6 @@
"id": "how-project-graph-is-built",
"tags": ["explore-graph"],
"file": "shared/concepts/how-project-graph-is-built"
},
{
"name": "Nx and the Nx Wrapper",
"id": "nx-and-the-wrapper",
"file": "shared/guides/nx-and-the-wrapper"
},
{
"name": "Managing your Global Nx Installation",
"id": "global-nx",
"file": "shared/guides/global-nx"
}
]
}
Expand All @@ -460,6 +444,49 @@
"id": "recipes",
"description": "In depth recipes for common tasks",
"itemList": [
{
"name": "Tasks & Caching",
juristr marked this conversation as resolved.
Show resolved Hide resolved
"id": "running-tasks",
"description": "A series of recipes that show how to run tasks efficiently with Nx",
"itemList": [
{
"name": "Fine-tuning Caching with Inputs",
"id": "customizing-inputs",
"tags": ["run-tasks", "cache-task-results"],
"file": "shared/recipes/running-tasks/customizing-inputs"
},
{
"name": "Defining a Task Pipeline",
"id": "defining-task-pipeline",
"tags": ["run-tasks"],
"file": "shared/recipes/running-tasks/defining-task-pipeline"
},
{
"name": "Running Custom Commands",
"id": "run-commands-executor",
"tags": ["run-tasks", "use-task-executors"],
"file": "shared/recipes/running-tasks/running-custom-commands"
},
{
"name": "Run Root-Level NPM Scripts with Nx",
"id": "root-level-scripts",
"tags": ["run-tasks"],
"file": "shared/recipes/running-tasks/root-level-scripts"
},
{
"name": "Workspace Watching",
"id": "workspace-watching",
"tags": ["run-tasks", "workspace-watching"],
"file": "shared/recipes/running-tasks/workspace-watching"
},
{
"name": "Reduce Repetitive Configuration",
"id": "reduce-repetitive-configuration",
"tags": [],
"file": "shared/recipes/running-tasks/reduce-repetitive-configuration"
}
]
},
{
"name": "Adopting Nx",
"id": "adopting-nx",
Expand Down Expand Up @@ -1013,30 +1040,12 @@
"tags": [],
"file": "shared/recipes/identify-dependencies-between-folders"
},
{
"name": "Reduce Repetitive Configuration",
"id": "reduce-repetitive-configuration",
"tags": [],
"file": "shared/recipes/reduce-repetitive-configuration"
},
{
"name": "Run Root-Level NPM Scripts with Nx",
"id": "root-level-scripts",
"tags": ["run-tasks"],
"file": "shared/recipes/root-level-scripts"
},
{
"name": "Disable Graph Links Created from Analyzing Source Files",
"id": "analyze-source-files",
"tags": ["explore-graph"],
"file": "shared/recipes/analyze-source-files"
},
{
"name": "Workspace Watching",
"id": "workspace-watching",
"tags": ["workspace-watching"],
"file": "shared/recipes/workspace-watching"
},
{
"name": "Use JavaScript instead TypeScript",
"id": "js-and-ts",
Expand All @@ -1048,12 +1057,6 @@
"tags": ["automate-updating-dependencies"],
"file": "shared/recipes/advanced-update"
},
{
"name": "Running Custom Commands",
"id": "run-commands-executor",
"tags": ["use-task-executors"],
"file": "shared/running-custom-commands"
},
{
"name": "Using Yarn PnP",
"id": "yarn-pnp",
Expand Down
Loading