Skip to content

Commit

Permalink
chore(nxdev): reorganize nx plugin content (nrwl#9758)
Browse files Browse the repository at this point in the history
  • Loading branch information
AgentEnder committed Apr 18, 2022
1 parent a2546a8 commit 4f1c14c
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 8 deletions.
17 changes: 11 additions & 6 deletions docs/map.json
Expand Up @@ -89,11 +89,6 @@
"id": "affected",
"file": "shared/using-nx/affected"
},
{
"name": "Nx Plugins and Devkit",
"id": "nx-devkit",
"file": "shared/devkit-and-nx-plugins"
},
{
"name": "CI Setup",
"id": "ci-overview",
Expand All @@ -110,10 +105,20 @@
"name": "Extending Nx",
"id": "extending-nx",
"itemList": [
{
"name": "Nx Plugins and Devkit",
"id": "nx-devkit",
"file": "shared/extending-nx/devkit-and-nx-plugins"
},
{
"name": "Project Inference Plugins",
"id": "project-inference-plugins",
"file": "shared/extending-nx/project-inference-plugins"
},
{
"name": "Project Graph Plugins",
"id": "project-graph-plugins",
"file": "shared/extending-nx/project-graph-plugins"
}
]
},
Expand Down Expand Up @@ -1355,7 +1360,7 @@
{
"name": "Extending the Project Graph",
"id": "project-graph-plugins",
"file": "shared/workspace/project-graph-plugins"
"file": "shared/extending-nx/project-graph-plugins"
}
]
},
Expand Down
@@ -1,6 +1,6 @@
# Nx Plugins and Devkit

Nx is a VSCode of build tools. The core of Nx enables project and task graph creation and analysis, orchestration and
Nx is like the VSCode of build tools. The core of Nx enables project and task graph creation and analysis, orchestration and
execution of tasks, computation caching, and code generation. [Nx plugins](#nx-plugins) extend this functionality and are built on top of the underlying [Nx Devkit](#nx-devkit).

> Many organizations use Nx without any plugins. If you are mainly interested in making your workspace faster or enabling distributed task execution, then plugins aren't necessary.
Expand Down
2 changes: 2 additions & 0 deletions docs/shared/generators/workspace-generators.md
@@ -1,3 +1,5 @@
> In Nx 13.10, we introduced the ability to run generators from Nx plugins in the workspace they were created in. By using a "local" plugin, you can set the plugin as your workspace's default collection and get several other affordances that are not provided to workspace generators. This is the preferred method for "workspace generators", and existing generators will eventually be transitioned to use a local plugin. Check the [nx-plugin guide](/nx-plugin/overview) for information on creating a new plugin.
# Workspace Generators

Workspace generators provide a way to automate many tasks you regularly perform as part of your development workflow. Whether it is scaffolding out components, features, or ensuring libraries are generated and structured in a certain way, generators help you standardize these tasks in a consistent, and predictable manner. Nx provides tooling around creating, and running custom generators from within your workspace. This guide shows you how to create, run, and customize workspace generators within your Nx workspace.
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/nx-plugin.md
Expand Up @@ -254,7 +254,7 @@ export default async function (tree: Tree, options: PresetGeneratorSchema) {

To get an in-depth guide on customizing/running or debugging your generator see [workspace generators](https://nx.dev/generators/workspace-generators#running-a-workspace-generator).

### Usage
#### Usage

Before you are able to use your newly created preset you must package and publish it to a registry.

Expand Down
2 changes: 2 additions & 0 deletions nx-dev/nx-dev/redirect-rules.config.js
Expand Up @@ -151,6 +151,8 @@ const guideUrls = {
'/core-extended/affected': '/using-nx/affected',
'/core-extended/computation-caching': '/using-nx/caching',
'/guides/nextjs': '/next/overview',
'/using-nx/nx-devkit': '/extending-nx/nx-devkit',
'/structure/project-graph-plugins': '/extending-nx/project-graph-plugins',
};

/**
Expand Down

0 comments on commit 4f1c14c

Please sign in to comment.