Merge pull request #907 from Eskibear/walkthru
refine walkthrough steps
@@ -46,38 +46,38 @@
|
||||
"steps": [
|
||||
{
|
||||
"id": "new-project-using-initializr",
|
||||
"title": "Create a new Spring Boot project",
|
||||
"description": "The easiest way to create new Spring Boot projects in VS Code is to use the Spring Initializr integration. Open the command palette in VS Code, search for __Spring__ and create a new Spring Boot project from there.\n[Create New Spring Boot Project](command:spring.initializr.maven-project)",
|
||||
"title": "Start with a Spring Boot project",
|
||||
"description": "The easiest way to create new Spring Boot projects in VS Code is to use the Spring Initializr integration. Open the command palette in VS Code, search for __Spring__ and create a new Spring Boot project from there.\n[Create New Project](command:spring.initializr.maven-project)\nYou can also start with a sample project to try the full features. Below button helps you try the [Spring PetClinic](https://github.com/spring-projects/spring-petclinic) sample project with one-click.\n[Open Sample Project](command:git.clone?%5B%22https%3A%2F%2Fgithub.com%2Fspring-projects%2Fspring-petclinic%22%5D)",
|
||||
"media": {
|
||||
"image": "walkthroughs/spring-initializr-integration.png",
|
||||
"svg": "walkthroughs/spring-initializr-integration.svg",
|
||||
"altText": "Create a new Maven-based Spring Boot project"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "navigate-your-spring-projects",
|
||||
"title": "Navigate your Spring Boot projects",
|
||||
"description": "The Spring Tools in your VS Code installation contribute Spring-specific symbols to help you navigate your projects. All the symbols start with `@`.\nYou can navigate to the symbols using the [Outline View](command:outline.focus) of the current file, via the [Go to Symbol in Editor...](command:workbench.action.gotoSymbol) or globally via [Go to symbol in Workspace...](command:workbench.action.showAllSymbols).\nIf you start your search with an `@`, the list of symbols will show the Spring-specific symbols only.\nSome of the symbols are also shown as part of the Spring Boot Dashboard perspective, like all your Spring bean definitions and Spring MVC request mappings.\n[Reveal in Spring Boot Dashboard](command:spring.apps.focus)",
|
||||
"id": "explore-your-spring-projects",
|
||||
"title": "Explore your projects",
|
||||
"description": "The Spring Tools in your VS Code installation contribute Spring-specific symbols to help you navigate your projects. All the symbols start with `@`.\nYou can navigate to the symbols using the [Outline View](command:outline.focus) of the current file, or globally via [Go to Symbol in Workspace...](command:workbench.action.quickOpen?%5B%22%23%40%22%5D).\nSome of the symbols are also shown as part of the Spring Boot Dashboard perspective, like all your Spring bean definitions and Spring MVC request mappings.\n[Reveal in Spring Boot Dashboard](command:spring.apps.focus)",
|
||||
"media": {
|
||||
"image": "walkthroughs/spring-symbols-navigation.png",
|
||||
"svg": "walkthroughs/spring-symbols-navigation.svg",
|
||||
"altText": "Go to Symbol in Workspace..."
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "run-your-spring-projects",
|
||||
"title": "Run your Spring Boot projects",
|
||||
"description": "Running your Spring Boot projects from within VS Code is simple: Open any Java source file from your project and press `Run` at the top right corner.\nThe second option is to [switch to the launch section](command:workbench.view.debug) of VS Code and start the app there.",
|
||||
"title": "Run your projects",
|
||||
"description": "Running your projects by clicking $(play) button in Spring Boot dashboard. Or you can open any Java source file from your project and press F5.\nFor advanced configurations, you can [switch to Run and Debug view](command:workbench.view.debug) of VS Code and start the app there.\n[Run Your Project](command:workbench.action.debug.start)",
|
||||
"media": {
|
||||
"image": "walkthroughs/spring-run-app.png",
|
||||
"svg": "walkthroughs/spring-run-app.svg",
|
||||
"altText": "Run your Spring Boot app"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "live-information-for-your-running-spring-app",
|
||||
"title": "Show live information from your running Spring Boot application",
|
||||
"description": "A unique feature of the Spring Tools is the ability to vizualize live data from your running app inplace with the source code of the running application.\n",
|
||||
"title": "View live information from your running application",
|
||||
"description": "A unique feature of the Spring Tools is the ability to vizualize live data from your running app inplace with the source code of the **running** application.\nTo view the live information, start your project from the [dashboard](command:spring.apps.focus) first.\n[Show Live Beans](command:spring.beans.focus)\n[Show Live Mappings](command:spring.mappings.focus)",
|
||||
"media": {
|
||||
"markdown": "walkthroughs/live-information.md",
|
||||
"altText": "Run your Spring Boot app"
|
||||
"svg": "walkthroughs/live-information.svg",
|
||||
"altText": "Show Live Information"
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
## Look inside of your running Spring Boot application
|
||||
|
||||
Spring Tools 4 can display live metadata information of a running Spring Boot application direclty in place in the source code.
|
||||
|
||||
### Configure the launch config
|
||||
|
||||
The live information is provided by [Spring Boot Actuators](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator), so you need to have he Spring Boot Actuator module on the classpath of your project. In addition to that the information is exchanged between the running app and the tools via JMX, so you need to enable JMX for your app. This can be done by adding a specific JVM argument to the [launch configuration](command:workbench.action.debug.configure):
|
||||
|
||||
`"vmArgs": "-Dspring.jmx.enabled=true"`
|
||||
|
||||
### Show the live information
|
||||
|
||||
In order to connect to a running application, you need to execute the [Manage Live Spring Boot Process Connections](vscode-spring-boot.live-hover.connect) command (e.g. via the command palette).
|
||||
|
||||

|
||||
|
||||
Then, the command shows up a list of running processes, from which you can select the app to connect to.
|
||||
|
||||

|
||||
|
||||
Once connected, the live information shows up in place with the source code of your application.
|
||||
|
||||

|
||||
|
||||
### Update and disconnect
|
||||
|
||||
If you have VS Code connected to a running app, you can execute the same command again to refresh the information or to disconnect from the running app again. The quick pick choices will show you up with those options for connected processes.
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 252 KiB |
|
Before Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 251 KiB |
325
vscode-extensions/boot-dev-pack/walkthroughs/spring-run-app.svg
Normal file
|
After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 938 KiB |
|
After Width: | Height: | Size: 114 KiB |