Merge pull request #2261 from gitbucket/add_remote_debug_doc

Add documentation for remote debug

doc/debug.md

@@ -0,0 +1,22 @@
+Debug GitBucket on IntelliJ
+========
+Add following configuration for allowing remote debugging to `buils.sbt`:
+
+```scala
+javaOptions in Jetty ++= Seq(
+  "-Xdebug",
+  "-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000"
+)
+```
+
+Run GitBucket:
+
+```shell
+$ sbt ~jetty:start
+```
+
+In IntelliJ, create remote debug configuration as follows. Make sure port number is same as above configuration.
+
+![Remote debug configuration on IntelliJ](remote_debug.png)
+
+Then you can start debugging on IntelliJ!

doc/readme.md

@@ -1,6 +1,7 @@
 Developer's Guide
 ========
  * [Build from source tree](build.md)
+ * [Debug on IntelliJ](debug.md)
  * [Directory Structure](directory.md)
  * [Mapping and Validation](validation.md)
  * [Authentication in Controller](authenticator.md)