[incubator-hop-docs] branch asf-site updated: How to debug in your development environment.

[ha...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hansva pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-docs.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new dc4db1f  How to debug in your development environment.
     new c0c6b7e  Merge pull request #18 from mattcasters/asf-site
dc4db1f is described below

commit dc4db1f291657fe40a2bb7be2186438f5eab045a
Author: Matt Casters <ma...@gmail.com>
AuthorDate: Sat Dec 5 15:14:48 2020 +0100

    How to debug in your development environment.
---
 .../modules/ROOT/pages/setup-dev-environment.adoc  | 24 +++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/hop-dev-manual/modules/ROOT/pages/setup-dev-environment.adoc b/hop-dev-manual/modules/ROOT/pages/setup-dev-environment.adoc
index 4242b0d..7f4bf32 100644
--- a/hop-dev-manual/modules/ROOT/pages/setup-dev-environment.adoc
+++ b/hop-dev-manual/modules/ROOT/pages/setup-dev-environment.adoc
@@ -10,7 +10,7 @@ We assume you're going to be using the IntelliJ IDEA integrated development envi
 
 If you visit the https://github.com/apache/incubator-hop[Apache Hop code] on github you'll notice a Fork icon on the top right of the page:
 
-image::github-fork.png[]
+image::github-fork.png[width="25%"]
 
 Use this button to create a copy of the complete Hop codebase.  You can then work on this fork in all safety.
 We call this new fork "origin" and the master copy of the Hop codebase "upstream" from your point of view.
@@ -20,7 +20,7 @@ We call this new fork "origin" and the master copy of the Hop codebase "upstream
 Now that you have your own fork it's time to clone it onto your work computer.  We're going to assume you set up github security with proper keys and so on.
 To get the URL of your fork you can use the copy button on this GitHub page:
 
-image::github-repository-url.png[]
+image::github-repository-url.png[width="75%"]
 
 You can now run a command like this:
 
@@ -41,7 +41,7 @@ This will ask you to navigate to our new ```incubator-hop``` folder.
 
 Then you need to choose to import the project from external model "Maven":
 
-image::idea-new-project-maven.png[]
+image::idea-new-project-maven.png[width="75%"]
 
 == Building the project
 
@@ -82,6 +82,24 @@ To install it in IntelliJ IDEA:
 
 All code which gets accepted into Hop is re-formatted with google-java-format via the pull request validation system.
 
+== Debugging
+
+To debug the Hop GUI or a long running pipeline or workflow you can change the launch scripts and uncomment the line with the 5005 port in it:
+
+[source]
+----
+# optional line for attaching a debugger
+#
+HOP_OPTIONS="${HOP_OPTIONS} -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"
+----
+
+In IntelliJ you can now start a remote debugging session using the menu:
+
+**Run -- Attach to process...
+**
+
+You can now set breakpoints in your code and see what's going on.
+
 == Committing work
 
 Updating your fork can be done simply by committing locally and then pushing those changes to "origin".