docs(core): add recipe on console & project details view integration (#21577)

This commit is contained in:
MaxKless 2024-02-03 21:50:18 -05:00 committed by GitHub
parent 9ccdb706a2
commit cc282b2d9c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 83 additions and 0 deletions

View File

@ -2260,6 +2260,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details",
"id": "console-project-details",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command",
@ -4045,6 +4053,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details",
"id": "console-project-details",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command",
@ -4104,6 +4120,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details",
"id": "console-project-details",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command",

View File

@ -3090,6 +3090,17 @@
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
{
"id": "console-project-details",
"name": "Project Details View",
"description": "",
"mediaImage": "",
"file": "shared/recipes/console-project-details",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-project-details",
"tags": ["integrate-with-editors"]
},
{
"id": "console-generate-command",
"name": "Generate Command",
@ -5537,6 +5548,17 @@
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
{
"id": "console-project-details",
"name": "Project Details View",
"description": "",
"mediaImage": "",
"file": "shared/recipes/console-project-details",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-project-details",
"tags": ["integrate-with-editors"]
},
{
"id": "console-generate-command",
"name": "Generate Command",
@ -5619,6 +5641,17 @@
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
"/recipes/nx-console/console-project-details": {
"id": "console-project-details",
"name": "Project Details View",
"description": "",
"mediaImage": "",
"file": "shared/recipes/console-project-details",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-project-details",
"tags": ["integrate-with-editors"]
},
"/recipes/nx-console/console-generate-command": {
"id": "console-generate-command",
"name": "Generate Command",

View File

@ -453,6 +453,13 @@
"name": "Telemetry",
"path": "/recipes/nx-console/console-telemetry"
},
{
"description": "",
"file": "shared/recipes/console-project-details",
"id": "console-project-details",
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details"
},
{
"description": "",
"file": "shared/recipes/console-generate-command",

View File

@ -1088,6 +1088,12 @@
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-telemetry"
},
{
"name": "Project Details View",
"id": "console-project-details",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-project-details"
},
{
"name": "Generate Command",
"id": "console-generate-command",

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

View File

@ -0,0 +1,12 @@
# Nx Console Project Details View
Nx Console provides seamless integration with the [Project Details View](features/explore-graph#explore-projects-in-your-workspace).
You can learn more about your project, run tasks or navigate the task graph with just a few clicks!
![console-pdv-example.png](/shared/images/nx-console/console-pdv-example.png)
You can access the integrated Project Details View in multiple ways:
- By clicking on the Preview icon to the top right of your `project.json`, `package.json` or any file that modifies targets (for example `jest.config.ts` or `cypress.config.ts`)
- By using the codelenses in any of these files
- By running the `Nx: Open Project Details to Side` action while any file in a project is open

View File

@ -173,6 +173,7 @@
- [Profiling Build Performance](/recipes/troubleshooting/performance-profiling)
- [Nx Console](/recipes/nx-console)
- [Telemetry](/recipes/nx-console/console-telemetry)
- [Project Details View](/recipes/nx-console/console-project-details)
- [Generate Command](/recipes/nx-console/console-generate-command)
- [Run Command](/recipes/nx-console/console-run-command)
- [Add Dependency Command](/recipes/nx-console/console-add-dependency-command)