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): plugin section #16314

Merged
merged 25 commits into from
May 5, 2023
Merged

docs(core): plugin section #16314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
435bad8
docs(core): add nx champions page
isaacplmann Mar 9, 2023
8f19e39
docs(core): plugins section in progress
isaacplmann Apr 12, 2023
3af0ae5
docs(core): plugins section
isaacplmann Apr 14, 2023
9b3b5dc
docs(core): fix plugins header link
isaacplmann Apr 14, 2023
453b2e7
docs(core): update menu
isaacplmann Apr 19, 2023
89744ed
chore(core): tutorials
isaacplmann Apr 21, 2023
63e05a4
docs(core): update file tree
isaacplmann Apr 25, 2023
339b5bd
docs(core): finish tutorials
isaacplmann Apr 26, 2023
abf80ad
docs(core): fixes
isaacplmann Apr 26, 2023
414ee7d
docs(core): plugins section
isaacplmann Apr 26, 2023
6643d73
docs(core): update plugin intro
isaacplmann Apr 26, 2023
aaf6753
docs(core): fix links and link checker
isaacplmann Apr 27, 2023
ab92cf3
docs(core): fix links
isaacplmann Apr 27, 2023
bc37917
docs(core): remove nx framework cli docs
isaacplmann Apr 27, 2023
76c6223
docs(core): rebase conflicts
isaacplmann Apr 28, 2023
ce9d39a
docs(core): local plugins use generator
isaacplmann Apr 28, 2023
ec9ef0e
docs(core): fix plugin names
isaacplmann Apr 28, 2023
72041cd
docs(core): fix plugin names
isaacplmann Apr 28, 2023
a918f63
docs(core): update e2e tests in tutorial
isaacplmann Apr 28, 2023
2c8ba25
docs(core): fix imports
isaacplmann Apr 28, 2023
7870873
docs(core): update registry SEO description
isaacplmann Apr 28, 2023
32788e5
docs(core): update getting started SEO description
isaacplmann Apr 28, 2023
646dea3
docs(core): merge conflicts
isaacplmann May 5, 2023
fd51f5f
docs(core): merge conflicts
isaacplmann May 5, 2023
d353f66
docs(core): add registry redirect on community page
isaacplmann May 5, 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
514 changes: 288 additions & 226 deletions docs/generated/manifests/menus.json
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 0 additions & 20 deletions docs/generated/manifests/nx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1083,16 +1083,6 @@
"isExternal": false,
"path": "/plugin-features/use-code-generators",
"tags": ["use-code-generators"]
},
{
"id": "create-your-own-plugin",
"name": "Create Your Own Plugin",
"description": "",
"file": "shared/plugin-features/create-your-own-plugin",
"itemList": [],
"isExternal": false,
"path": "/plugin-features/create-your-own-plugin",
"tags": ["create-your-own-plugin"]
}
],
"isExternal": false,
Expand All @@ -1119,16 +1109,6 @@
"path": "/plugin-features/use-code-generators",
"tags": ["use-code-generators"]
},
"/plugin-features/create-your-own-plugin": {
"id": "create-your-own-plugin",
"name": "Create Your Own Plugin",
"description": "",
"file": "shared/plugin-features/create-your-own-plugin",
"itemList": [],
"isExternal": false,
"path": "/plugin-features/create-your-own-plugin",
"tags": ["create-your-own-plugin"]
},
"/concepts": {
"id": "concepts",
"name": "Concepts",
Expand Down
335 changes: 335 additions & 0 deletions docs/generated/manifests/plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,335 @@
{
"/plugins/intro": {
"id": "intro",
"name": "Intro",
"description": "Learn about plugins.",
"file": "",
"itemList": [
{
"id": "getting-started",
"name": "Getting Started with Plugins",
"description": "Learn how to extend Nx by creating and releasing your own Nx plugin.",
"file": "shared/plugins/intro",
"itemList": [],
"isExternal": false,
"path": "/plugins/intro/getting-started",
"tags": []
},
{
"id": "registry",
"name": "Plugin Registry",
"description": "Browse official and community plugins",
"file": "",
"itemList": [],
"isExternal": false,
"path": "/plugins/registry",
"tags": []
}
],
"isExternal": false,
"path": "/plugins/intro",
"tags": []
},
"/plugins/intro/getting-started": {
"id": "getting-started",
"name": "Getting Started with Plugins",
"description": "Learn how to extend Nx by creating and releasing your own Nx plugin.",
"file": "shared/plugins/intro",
"itemList": [],
"isExternal": false,
"path": "/plugins/intro/getting-started",
"tags": []
},
"/plugins/registry": {
"id": "registry",
"name": "Plugin Registry",
"description": "Browse official and community plugins",
"file": "",
"itemList": [],
"isExternal": false,
"path": "/plugins/registry",
"tags": []
},
"/plugins/tutorials": {
"id": "tutorials",
"name": "5 Min Tutorials",
"description": "Get started with plugins",
"file": "",
"itemList": [
{
"id": "create-plugin",
"name": "Create a Local Plugin",
"description": "",
"file": "shared/plugins/create-plugin",
"itemList": [],
"isExternal": false,
"path": "/plugins/tutorials/create-plugin",
"tags": []
},
{
"id": "publish-plugin",
"name": "Maintain a Published Plugin",
"description": "",
"file": "shared/plugins/maintain-published-plugin",
"itemList": [],
"isExternal": false,
"path": "/plugins/tutorials/publish-plugin",
"tags": []
}
],
"isExternal": false,
"path": "/plugins/tutorials",
"tags": []
},
"/plugins/tutorials/create-plugin": {
"id": "create-plugin",
"name": "Create a Local Plugin",
"description": "",
"file": "shared/plugins/create-plugin",
"itemList": [],
"isExternal": false,
"path": "/plugins/tutorials/create-plugin",
"tags": []
},
"/plugins/tutorials/publish-plugin": {
"id": "publish-plugin",
"name": "Maintain a Published Plugin",
"description": "",
"file": "shared/plugins/maintain-published-plugin",
"itemList": [],
"isExternal": false,
"path": "/plugins/tutorials/publish-plugin",
"tags": []
},
"/plugins/recipes": {
"id": "recipes",
"name": "Recipes",
"description": "Focused instructions to complete a specific task",
"file": "",
"itemList": [
{
"id": "local-executors",
"name": "Write a Simple Executor",
"description": "",
"file": "shared/recipes/plugins/local-executors",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/local-executors",
"tags": ["use-task-executors"]
},
{
"id": "compose-executors",
"name": "Compose Executors",
"description": "",
"file": "shared/recipes/plugins/compose-executors",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/compose-executors",
"tags": ["use-task-executors"]
},
{
"id": "local-generators",
"name": "Write a Simple Generator",
"description": "",
"file": "shared/recipes/generators/local-generators",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/local-generators",
"tags": ["use-code-generators"]
},
{
"id": "composing-generators",
"name": "Compose Generators",
"description": "",
"file": "shared/recipes/generators/composing-generators",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/composing-generators",
"tags": ["use-code-generators"]
},
{
"id": "generator-options",
"name": "Provide Options for Generators",
"description": "",
"file": "shared/recipes/generators/generator-options",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/generator-options",
"tags": ["use-code-generators"]
},
{
"id": "creating-files",
"name": "Create Files",
"description": "",
"file": "shared/recipes/generators/creating-files",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/creating-files",
"tags": ["use-code-generators"]
},
{
"id": "modifying-files",
"name": "Modify Files",
"description": "",
"file": "shared/recipes/generators/modifying-files",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/modifying-files",
"tags": ["use-code-generators"]
},
{
"id": "migration-generators",
"name": "Write a Migration",
"description": "",
"file": "shared/recipes/plugins/migration-generators",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/migration-generators",
"tags": ["create-your-own-plugin"]
},
{
"id": "create-preset",
"name": "Create a Preset",
"description": "",
"file": "shared/recipes/plugins/create-preset",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/create-preset",
"tags": ["create-your-own-plugin"]
},
{
"id": "project-graph-plugins",
"name": "Modify the Project Graph",
"description": "",
"file": "shared/recipes/plugins/project-graph-plugins",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/project-graph-plugins",
"tags": ["create-your-own-plugin", "explore-graph"]
},
{
"id": "project-inference-plugins",
"name": "Identify Custom Projects",
"description": "",
"file": "shared/recipes/plugins/project-inference-plugins",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/project-inference-plugins",
"tags": ["create-your-own-plugin"]
}
],
"isExternal": false,
"path": "/plugins/recipes",
"tags": []
},
"/plugins/recipes/local-executors": {
"id": "local-executors",
"name": "Write a Simple Executor",
"description": "",
"file": "shared/recipes/plugins/local-executors",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/local-executors",
"tags": ["use-task-executors"]
},
"/plugins/recipes/compose-executors": {
"id": "compose-executors",
"name": "Compose Executors",
"description": "",
"file": "shared/recipes/plugins/compose-executors",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/compose-executors",
"tags": ["use-task-executors"]
},
"/plugins/recipes/local-generators": {
"id": "local-generators",
"name": "Write a Simple Generator",
"description": "",
"file": "shared/recipes/generators/local-generators",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/local-generators",
"tags": ["use-code-generators"]
},
"/plugins/recipes/composing-generators": {
"id": "composing-generators",
"name": "Compose Generators",
"description": "",
"file": "shared/recipes/generators/composing-generators",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/composing-generators",
"tags": ["use-code-generators"]
},
"/plugins/recipes/generator-options": {
"id": "generator-options",
"name": "Provide Options for Generators",
"description": "",
"file": "shared/recipes/generators/generator-options",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/generator-options",
"tags": ["use-code-generators"]
},
"/plugins/recipes/creating-files": {
"id": "creating-files",
"name": "Create Files",
"description": "",
"file": "shared/recipes/generators/creating-files",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/creating-files",
"tags": ["use-code-generators"]
},
"/plugins/recipes/modifying-files": {
"id": "modifying-files",
"name": "Modify Files",
"description": "",
"file": "shared/recipes/generators/modifying-files",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/modifying-files",
"tags": ["use-code-generators"]
},
"/plugins/recipes/migration-generators": {
"id": "migration-generators",
"name": "Write a Migration",
"description": "",
"file": "shared/recipes/plugins/migration-generators",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/migration-generators",
"tags": ["create-your-own-plugin"]
},
"/plugins/recipes/create-preset": {
"id": "create-preset",
"name": "Create a Preset",
"description": "",
"file": "shared/recipes/plugins/create-preset",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/create-preset",
"tags": ["create-your-own-plugin"]
},
"/plugins/recipes/project-graph-plugins": {
"id": "project-graph-plugins",
"name": "Modify the Project Graph",
"description": "",
"file": "shared/recipes/plugins/project-graph-plugins",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/project-graph-plugins",
"tags": ["create-your-own-plugin", "explore-graph"]
},
"/plugins/recipes/project-inference-plugins": {
"id": "project-inference-plugins",
"name": "Identify Custom Projects",
"description": "",
"file": "shared/recipes/plugins/project-inference-plugins",
"itemList": [],
"isExternal": false,
"path": "/plugins/recipes/project-inference-plugins",
"tags": ["create-your-own-plugin"]
}
}
Loading