Skip to content

Commit

Permalink
docs(core): restructure plugin docs (#14349)
Browse files Browse the repository at this point in the history
  • Loading branch information
@isaacplmann
isaacplmann authored Jan 13, 2023
1 parent 415d1c7 commit b96a178
Show file tree
Hide file tree
Showing 21 changed files with 515 additions and 344 deletions.
60 changes: 54 additions & 6 deletions docs/generated/manifests/menus.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2210,9 +2210,25 @@
"isExternal": false,
"children": [
{
"name": "Project Inference Plugins",
"path": "/recipes/advanced-plugins/project-inference-plugins",
"id": "project-inference-plugins",
"name": "Share Your Plugin",
"path": "/recipes/advanced-plugins/share-your-plugin",
"id": "share-your-plugin",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Create a Preset",
"path": "/recipes/advanced-plugins/create-preset",
"id": "create-preset",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Migration Generators",
"path": "/recipes/advanced-plugins/migration-generators",
"id": "migration-generators",
"isExternal": false,
"children": [],
"disableCollapsible": false
Expand All @@ -2224,14 +2240,38 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Project Inference Plugins",
"path": "/recipes/advanced-plugins/project-inference-plugins",
"id": "project-inference-plugins",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"disableCollapsible": false
},
{
"name": "Project Inference Plugins",
"path": "/recipes/advanced-plugins/project-inference-plugins",
"id": "project-inference-plugins",
"name": "Share Your Plugin",
"path": "/recipes/advanced-plugins/share-your-plugin",
"id": "share-your-plugin",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Create a Preset",
"path": "/recipes/advanced-plugins/create-preset",
"id": "create-preset",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Migration Generators",
"path": "/recipes/advanced-plugins/migration-generators",
"id": "migration-generators",
"isExternal": false,
"children": [],
"disableCollapsible": false
Expand All @@ -2244,6 +2284,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Inference Plugins",
"path": "/recipes/advanced-plugins/project-inference-plugins",
"id": "project-inference-plugins",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Environment Variables",
"path": "/recipes/environment-variables",
Expand Down
118 changes: 89 additions & 29 deletions docs/generated/manifests/recipes.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -513,17 +513,17 @@
"id": "creating-custom-executors",
"name": "Local Executors",
"description": "",
"file": "shared/recipes/local-executors",
"file": "shared/recipes/plugins/local-executors",
"itemList": [],
"isExternal": false,
"path": "/recipes/executors/creating-custom-executors",
"tags": ["use-task-executors"]
"tags": ["use-task-executors", "create-your-own-plugin"]
},
{
"id": "compose-executors",
"name": "Compose Executors",
"description": "",
"file": "shared/recipes/compose-executors",
"file": "shared/recipes/plugins/compose-executors",
"itemList": [],
"isExternal": false,
"path": "/recipes/executors/compose-executors",
Expand Down Expand Up @@ -558,17 +558,17 @@
"id": "creating-custom-executors",
"name": "Local Executors",
"description": "",
"file": "shared/recipes/local-executors",
"file": "shared/recipes/plugins/local-executors",
"itemList": [],
"isExternal": false,
"path": "/recipes/executors/creating-custom-executors",
"tags": ["use-task-executors"]
"tags": ["use-task-executors", "create-your-own-plugin"]
},
"/recipes/executors/compose-executors": {
"id": "compose-executors",
"name": "Compose Executors",
"description": "",
"file": "shared/recipes/compose-executors",
"file": "shared/recipes/plugins/compose-executors",
"itemList": [],
"isExternal": false,
"path": "/recipes/executors/compose-executors",
Expand All @@ -584,17 +584,17 @@
"id": "local-generators",
"name": "Local Generators",
"description": "",
"file": "shared/recipes/local-generators",
"file": "shared/recipes/generators/local-generators",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/local-generators",
"tags": ["use-code-generators"]
"tags": ["use-code-generators", "create-your-own-plugin"]
},
{
"id": "composing-generators",
"name": "Composing Generators",
"description": "",
"file": "shared/generators/composing-generators",
"file": "shared/recipes/generators/composing-generators",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/composing-generators",
Expand All @@ -604,7 +604,7 @@
"id": "generator-options",
"name": "Generator Options",
"description": "",
"file": "shared/generators/generator-options",
"file": "shared/recipes/generators/generator-options",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/generator-options",
Expand All @@ -614,7 +614,7 @@
"id": "creating-files",
"name": "Creating Files",
"description": "",
"file": "shared/generators/creating-files",
"file": "shared/recipes/generators/creating-files",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/creating-files",
Expand All @@ -624,7 +624,7 @@
"id": "modifying-files",
"name": "Modifying Files",
"description": "",
"file": "shared/generators/modifying-files",
"file": "shared/recipes/generators/modifying-files",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/modifying-files",
Expand All @@ -639,17 +639,17 @@
"id": "local-generators",
"name": "Local Generators",
"description": "",
"file": "shared/recipes/local-generators",
"file": "shared/recipes/generators/local-generators",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/local-generators",
"tags": ["use-code-generators"]
"tags": ["use-code-generators", "create-your-own-plugin"]
},
"/recipes/generators/composing-generators": {
"id": "composing-generators",
"name": "Composing Generators",
"description": "",
"file": "shared/generators/composing-generators",
"file": "shared/recipes/generators/composing-generators",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/composing-generators",
Expand All @@ -659,7 +659,7 @@
"id": "generator-options",
"name": "Generator Options",
"description": "",
"file": "shared/generators/generator-options",
"file": "shared/recipes/generators/generator-options",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/generator-options",
Expand All @@ -669,7 +669,7 @@
"id": "creating-files",
"name": "Creating Files",
"description": "",
"file": "shared/generators/creating-files",
"file": "shared/recipes/generators/creating-files",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/creating-files",
Expand All @@ -679,7 +679,7 @@
"id": "modifying-files",
"name": "Modifying Files",
"description": "",
"file": "shared/generators/modifying-files",
"file": "shared/recipes/generators/modifying-files",
"itemList": [],
"isExternal": false,
"path": "/recipes/generators/modifying-files",
Expand All @@ -692,50 +692,110 @@
"file": "",
"itemList": [
{
"id": "project-inference-plugins",
"name": "Project Inference Plugins",
"id": "share-your-plugin",
"name": "Share Your Plugin",
"description": "",
"file": "shared/extending-nx/project-inference-plugins",
"file": "shared/recipes/plugins/share-your-plugin",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/project-inference-plugins",
"path": "/recipes/advanced-plugins/share-your-plugin",
"tags": ["create-your-own-plugin"]
},
{
"id": "create-preset",
"name": "Create a Preset",
"description": "",
"file": "shared/recipes/plugins/create-preset",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/create-preset",
"tags": ["create-your-own-plugin"]
},
{
"id": "migration-generators",
"name": "Migration Generators",
"description": "",
"file": "shared/recipes/plugins/migration-generators",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/migration-generators",
"tags": ["create-your-own-plugin"]
},
{
"id": "project-graph-plugins",
"name": "Project Graph Plugins",
"description": "",
"file": "shared/extending-nx/project-graph-plugins",
"file": "shared/recipes/plugins/project-graph-plugins",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/project-graph-plugins",
"tags": ["create-your-own-plugin", "explore-graph"]
},
{
"id": "project-inference-plugins",
"name": "Project Inference Plugins",
"description": "",
"file": "shared/recipes/plugins/project-inference-plugins",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/project-inference-plugins",
"tags": ["create-your-own-plugin"]
}
],
"isExternal": false,
"path": "/recipes/advanced-plugins",
"tags": []
},
"/recipes/advanced-plugins/project-inference-plugins": {
"id": "project-inference-plugins",
"name": "Project Inference Plugins",
"/recipes/advanced-plugins/share-your-plugin": {
"id": "share-your-plugin",
"name": "Share Your Plugin",
"description": "",
"file": "shared/extending-nx/project-inference-plugins",
"file": "shared/recipes/plugins/share-your-plugin",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/project-inference-plugins",
"path": "/recipes/advanced-plugins/share-your-plugin",
"tags": ["create-your-own-plugin"]
},
"/recipes/advanced-plugins/create-preset": {
"id": "create-preset",
"name": "Create a Preset",
"description": "",
"file": "shared/recipes/plugins/create-preset",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/create-preset",
"tags": ["create-your-own-plugin"]
},
"/recipes/advanced-plugins/migration-generators": {
"id": "migration-generators",
"name": "Migration Generators",
"description": "",
"file": "shared/recipes/plugins/migration-generators",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/migration-generators",
"tags": ["create-your-own-plugin"]
},
"/recipes/advanced-plugins/project-graph-plugins": {
"id": "project-graph-plugins",
"name": "Project Graph Plugins",
"description": "",
"file": "shared/extending-nx/project-graph-plugins",
"file": "shared/recipes/plugins/project-graph-plugins",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/project-graph-plugins",
"tags": ["create-your-own-plugin", "explore-graph"]
},
"/recipes/advanced-plugins/project-inference-plugins": {
"id": "project-inference-plugins",
"name": "Project Inference Plugins",
"description": "",
"file": "shared/recipes/plugins/project-inference-plugins",
"itemList": [],
"isExternal": false,
"path": "/recipes/advanced-plugins/project-inference-plugins",
"tags": ["create-your-own-plugin"]
},
"/recipes/environment-variables": {
"id": "environment-variables",
"name": "Environment Variables",
Expand Down
Loading

0 comments on commit b96a178

Please sign in to comment.