Documentation - Remove not required param in markdown (3661a062) · Commits · Inteligr8 / alfresco-sdk-deletion_scheduled-31

docs/advanced-topics/debugging/debug-eclipse.md

+5 −5

Original line number	Diff line number	Diff line
		@@ -52,13 +52,13 @@ For more details on how to import an Alfresco project into your Eclipse IDE, see

		1. Open the Eclipse IDE and click on `Run Configurations` (top right).

		![Alt text](../../docassets/images/sdk-debug-eclipse-create.png?raw=true "Eclipse remote debug create configuration")
		![Alt text](../../docassets/images/sdk-debug-eclipse-create.png "Eclipse remote debug create configuration")

		2. Click on the green plus sign (top left) and select `Remote Java Application` to add a new configuration for a remote app.

		3. Enter a descriptive name for your configuration, for example, `Sample project ACS debug`.

		![Alt text](../../docassets/images/sdk-debug-eclipse-config.png?raw=true "Eclipse remote debug configuration detail")
		![Alt text](../../docassets/images/sdk-debug-eclipse-config.png "Eclipse remote debug configuration detail")

		4. Click Browse then locate the platform project JAR if you want to debug ACS or the share project JAR if you want to debug share.

		@@ -72,7 +72,7 @@ You will be taken back to the project source code.

		7. Click on the bug icon and select the new configuration to run it.

		![Alt text](../../docassets/images/sdk-debug-eclipse-launch.png?raw=true "Eclipse remote debug configuration launch")
		![Alt text](../../docassets/images/sdk-debug-eclipse-launch.png "Eclipse remote debug configuration launch")

		The IDE connects the source code to the deployed one at the docker container. Once the code is linked, you can open a browser and start using your
		application. In our case, we are going to test the behaviour of debugging by running the sample webscript.
		@@ -81,7 +81,7 @@ application. In our case, we are going to test the behaviour of debugging by run

		This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.

		![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "Hello World webscript original result")
		![Alt text](../../docassets/images/sdk-hellofromjava.png "Hello World webscript original result")

		Now let's find the `HelloWorldWebScript.java` file in the `src/main/java/.../platformsample` folder of your project. If you're using an All-In-One project,
		the folder is located in the platform sub-project.
		@@ -94,7 +94,7 @@ model.put(“fromJava”,”HelloFromJava”);

		10. Refresh the browser. Eclipse will intercept the execution at the breakpoint:

		![Alt text](../../docassets/images/sdk-debug-eclipse-breakpoint.png?raw=true "Eclipse remote debug stopped at breakpoint")
		![Alt text](../../docassets/images/sdk-debug-eclipse-breakpoint.png "Eclipse remote debug stopped at breakpoint")

		From here the management is the same as for a regular Java application using your preferred IDE. Please note that the whole Alfresco source code is available
		at debug time, thanks to the local maven repository.

docs/advanced-topics/debugging/debug-intellij.md

+5 −5

Original line number	Diff line number	Diff line
		@@ -52,13 +52,13 @@ For more details on how to import an Alfresco project into your IntelliJ IDEA ID

		1. Open the IntelliJ IDEA IDE and click on `Add/Edit Configurations` (top right).

		![Alt text](../../docassets/images/sdk-debug-intellij-create.png?raw=true "IntelliJ remote debug create configuration")
		![Alt text](../../docassets/images/sdk-debug-intellij-create.png "IntelliJ remote debug create configuration")

		2. Click on the plus icon (top left) and select `Remote` to add a new configuration for a remote app.

		3. Enter a descriptive name for your configuration, for example, `Sample project ACS debug`.

		![Alt text](../../docassets/images/sdk-debug-intellij-config.png?raw=true "IntelliJ remote debug configuration detail")
		![Alt text](../../docassets/images/sdk-debug-intellij-config.png "IntelliJ remote debug configuration detail")

		4. Check that your settings match the screenshot. This is a sample to debug ACS. If you want to debug share or you have configured custom ports for remote
		debugging you'll need to modify that configuration. If you're working with _Docker Toolbox_ instead of _Docker Desktop_ the host to access the container won't
		@@ -70,7 +70,7 @@ You will be taken back to the project source code.

		6. Click on the `Edit Configurations` dropdown box and select the new configuration to run it.

		![Alt text](../../docassets/images/sdk-debug-intellij-launch.png?raw=true "IntelliJ remote debug configuration launch")
		![Alt text](../../docassets/images/sdk-debug-intellij-launch.png "IntelliJ remote debug configuration launch")

		The IDE connects the source code with the deployed one at the docker container. Once the code is linked, you can open a browser and start using your
		application. In our case, we are going to test the behaviour of debugging by running the sample webscript.
		@@ -79,7 +79,7 @@ application. In our case, we are going to test the behaviour of debugging by run

		This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.

		![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "Hello World webscript original result")
		![Alt text](../../docassets/images/sdk-hellofromjava.png "Hello World webscript original result")

		Now let's find the `HelloWorldWebScript.java` file in the `src/main/java/.../platformsample` folder of your project. If you're using an All-In-One project,
		the folder is located in the platform sub-project.
		@@ -92,7 +92,7 @@ model.put(“fromJava”,”HelloFromJava”);

		9. Refresh the browser. IntelliJ IDEA will intercept the execution at the breakpoint:

		![Alt text](../../docassets/images/sdk-debug-intellij-breakpoint.png?raw=true "IntelliJ remote debug stopped at breakpoint")
		![Alt text](../../docassets/images/sdk-debug-intellij-breakpoint.png "IntelliJ remote debug stopped at breakpoint")

		From here the management is the same as for a regular Java application using your preferred IDE. Please note that the whole Alfresco source code is available
		at debug time, thanks to the local maven repository.

docs/advanced-topics/hot-reloading/hotswap-agent.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -252,7 +252,7 @@ You'll recognize HotSwapAgent is working when you see similar log messages:

		This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.

		![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "Hello World webscript original result")
		![Alt text](../../docassets/images/sdk-hellofromjava.png "Hello World webscript original result")

		3. Locate `HelloWorldWebScript.java` in the `src/main/java/.../platformsample` folder of your project (If you are using an All-In-One project, the folder is
		located in the platform sub-project).
		@@ -280,6 +280,6 @@ A number of log messages appear in the Alfresco project terminal, for example:

		6. Refresh the browser to see the updated message:

		![alt text](../../docassets/images/sdk-hellofromme.png?raw=true "Hello World webscript modified result")
		![alt text](../../docassets/images/sdk-hellofromme.png "Hello World webscript modified result")

		By changing the code and compiling it again, the changes have been dynamically received from Alfresco Content Services.

docs/advanced-topics/hot-reloading/jrebel.md

+8 −8

Original line number	Diff line number	Diff line
		@@ -35,16 +35,16 @@ _Note that a license is required. In this step you will be able to request a tri
		5. Select `Help > JRebel > Configuration > Remote servers` to add a new remote server.
		6. Give a descriptive name to the new server and set the `Server URL` as `http://localhost:8080/alfresco`.

		![Alt text](../../docassets/images/sdk-jrebel-eclipse-server.png?raw=true "Eclipse JRebel remote server configuration")
		![Alt text](../../docassets/images/sdk-jrebel-eclipse-server.png "Eclipse JRebel remote server configuration")

		7. Select the checkbox to enable the server synchronisation and the checkbox to `Synchronize on build`.

		![Alt text](../../docassets/images/sdk-jrebel-eclipse-servers.png?raw=true "Eclipse JRebel remote servers synchronization")
		![Alt text](../../docassets/images/sdk-jrebel-eclipse-servers.png "Eclipse JRebel remote servers synchronization")

		8. Select `Help > JRebel > Configuration > Projects` and select the checkbox to enable JRebel and the remote server support for required projects (the complete
		project in case of the Platform Jar archetype or the `PROJECT_ARTIFACT_ID-platform-jar` and `integration-tests` modules in case of the All-In-One archetype).

		![Alt text](../../docassets/images/sdk-jrebel-eclipse-projects.png?raw=true "Eclipse JRebel projects configuration")
		![Alt text](../../docassets/images/sdk-jrebel-eclipse-projects.png "Eclipse JRebel projects configuration")

		## Installing JRebel using IntelliJ IDEA

		@@ -58,16 +58,16 @@ _Note that a license is required. In this step you will be able to request a tri
		5. Select `Preferences > JRebel > Remote Servers` to add a new remote server.
		6. Give a descriptive name to the new server and set the `Server URL` as `http://localhost:8080/alfresco.

		![Alt text](../../docassets/images/sdk-jrebel-intellij-server.png?raw=true "Eclipse JRebel remote server configuration")
		![Alt text](../../docassets/images/sdk-jrebel-intellij-server.png "Eclipse JRebel remote server configuration")

		7. Select the checkbox to enable the server synchronisation and the checkbox to `Synchronize on build`.

		![Alt text](../../docassets/images/sdk-jrebel-intellij-servers.png?raw=true "Eclipse JRebel remote server configuration")
		![Alt text](../../docassets/images/sdk-jrebel-intellij-servers.png "Eclipse JRebel remote server configuration")

		8. Open the JRebel Panel and select the checkbox to enable JRebel and the remote server support for required projects (the complete project in case of the
		Platform Jar archetype or the `PROJECT_ARTIFACT_ID-platform-jar` and `integration-tests` modules in case of the All-In-One archetype).

		![Alt text](../../docassets/images/sdk-jrebel-intellij-projects.png?raw=true "Eclipse JRebel projects configuration")
		![Alt text](../../docassets/images/sdk-jrebel-intellij-projects.png "Eclipse JRebel projects configuration")

		## Configuring JRebel in the project

		@@ -142,7 +142,7 @@ You'll recognize JRebel is working when you see similar log messages:

		This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.

		![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "Hello World webscript original result")
		![Alt text](../../docassets/images/sdk-hellofromjava.png "Hello World webscript original result")

		3. Locate `HelloWorldWebScript.java` in the `src/main/java/.../platformsample` folder of your project (If you are using an All-In-One project, the folder is
		located in the platform sub-project).
		@@ -165,6 +165,6 @@ A number of log messages appear in the Alfresco project terminal, for example:

		6. Refresh the browser to see the updated message:

		![alt text](../../docassets/images/sdk-hellofromme.png?raw=true "Hello World webscript modified result")
		![alt text](../../docassets/images/sdk-hellofromme.png "Hello World webscript modified result")

		By changing the code and compiling it again, the changes have been dynamically received from Alfresco Content Services.

docs/advanced-topics/integration-testing/it-running.md

+4 −4

Original line number	Diff line number	Diff line
		@@ -78,11 +78,11 @@ the `build_start` or the `start` goal of the `run` script.

		4. Right click and select `Run As ...`, then click `JUnit Test`.

		![Alt text](../../docassets/images/sdk-it-eclipse-run.png?raw=true "Eclipse integration tests run")
		![Alt text](../../docassets/images/sdk-it-eclipse-run.png "Eclipse integration tests run")

		Once the tests have completed (typically, after a few seconds), the results are presented.

		![Alt text](../../docassets/images/sdk-it-eclipse-results.png?raw=true "Eclipse integration test execution results")
		![Alt text](../../docassets/images/sdk-it-eclipse-results.png "Eclipse integration test execution results")

		When using an IDE, the source code related to the integration tests is the one deployed directly on the platform side. This means that an update in the code
		for the Java classes will be included when you run the integration tests _if and only if_ they are deployed in the platform. To avoid stopping/starting
		@@ -104,11 +104,11 @@ the `build_start` or the `start` goal of the `run` script.

		4. Right click and select `Run Tests`.

		![Alt text](../../docassets/images/sdk-it-intellij-run.png?raw=true "IntelliJ IDEA integration tests run")
		![Alt text](../../docassets/images/sdk-it-intellij-run.png "IntelliJ IDEA integration tests run")

		Once the tests have completed (typically, after a few seconds), the results are presented.

		![Alt text](../../docassets/images/sdk-it-intellij-results.png?raw=true "IntelliJ IDEA integration test execution results")
		![Alt text](../../docassets/images/sdk-it-intellij-results.png "IntelliJ IDEA integration test execution results")

		When using an IDE, the source code related to the integration tests is the one deployed directly on the platform side. This means that an update in the code
		for the Java classes will be included when you run the integration tests _if and only if_ they are deployed in the platform. To avoid stopping/starting