update documentation for intellij debug

HomeOfTheWizard · Mar 24, 2024 · c5f285c · c5f285c
1 parent 1ee3a4f
commit c5f285c
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 23 deletions.
diff --git a/docs/assets/images/intellij_debug.PNG b/docs/assets/images/intellij_debug.PNG
diff --git a/docs/assets/images/run_config_intellij.PNG b/docs/assets/images/run_config_intellij.PNG
diff --git a/docs/use-cases/executionEnvs.markdown b/docs/use-cases/executionEnvs.markdown
@@ -142,26 +142,28 @@ If you want to debug your spring application locally, there are two ways to do t
 1.  In IntelliJ, you can run and debug maven goals, see [here](https://www.jetbrains.com/help/idea/run-debug-configuration-maven.html).  
     If you want to debug, the catch is not to let spring boot plugin to fork its JVM from the initial maven process. see [here](https://youtrack.jetbrains.com/issue/IDEA-175246)
 
-```xml
-<plugin>
-    <groupId>org.springframework.boot</groupId>
-    <artifactId>spring-boot-maven-plugin</artifactId>
-    <configuration>
-        <fork>false</fork>
-    </configuration>
-</plugin>
-```
-
-<p><img src="../assets/images/intellij_debug.PNG"/></p>
-
-2. Or, if you want to fork the JVM and debug only your application, you can set a remote debugger on any IDE by adding spring boot JVM args for the debugger connexion.
-
-```xml
-<plugin>
-    <groupId>org.springframework.boot</groupId>
-    <artifactId>spring-boot-maven-plugin</artifactId>
-    <configuration>
-        <jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8282</jvmArguments>
-    </configuration>
-</plugin>
-```
+    ```xml
+    <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+        <configuration>
+            <fork>false</fork>
+        </configuration>
+    </plugin>
+    ```
+
+    <p><img src="../assets/images/run_config_intellij.PNG"/></p>
+
+    A working demo project is available [here](https://github.com/HomeOfTheWizard/meeting-organiser).
+
+2.  Or, if you want to fork the JVM and debug only your application, you can set a remote debugger on any IDE by adding spring boot JVM args for the debugger connexion.
+
+    ```xml
+    <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+        <configuration>
+            <jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8282</jvmArguments>
+        </configuration>
+    </plugin>
+    ```