Commit ccee83f9 authored by Jose Luis Osorno's avatar Jose Luis Osorno
Browse files

Documentation - Reorganise documentation content 

Reorganise the documentation content to fix the required folder structure
and file naming for the migration to ABN.
parent 0027ef3e

docs/sdk.md→docs/README.md

+19 −19
Original line number Diff line number Diff line
@@ -31,27 +31,27 @@ code into place. 
* [What's new?]() **TODO**

* [Getting started with Alfresco SDK 4.0](getting-started.md)

* [Alfresco SDK Maven archetypes](mvn-archetypes.md)

* [Working with generated projects](projects-usage.md)

    * [All-In-One project structure](structure-aio.md)

    * [Platform JAR project structure](structure-platform.md)

    * [Share JAR project structure](structure-share.md)

* [Working with generated projects](working-with-generated-projects/README.md)

    * [All-In-One project structure](working-with-generated-projects/structure-aio.md)

    * [Platform JAR project structure](working-with-generated-projects/structure-platform.md)

    * [Share JAR project structure](working-with-generated-projects/structure-share.md)

* Setting up your development environment

    * [Setting up your development environment using Eclipse](dev-env-eclipse.md)

    * [Setting up your development environment using Intellij IDEA](dev-env-intellij.md)

    * [Setting up your development environment using Eclipse](setting-up-your-development-environment/dev-env-eclipse.md)

    * [Setting up your development environment using Intellij IDEA](setting-up-your-development-environment/dev-env-intellij.md)

* Advanced topics

    * [Switching Alfresco Content Services and Share versions](switching-versions.md)

    * [Working with Enterprise](enterprise.md)

        * [How to configure private Alfresco Nexus repository](enterprise-mvn-repo.md)

        * [How to configure private Alfresco Docker registry](enterprise-docker-registry.md)

        * [How to set up Alfresco Transform Service](alfresco-transform-service.md)

    * [Working with AMPs](amps.md)

    * [Switching Alfresco Content Services and Share versions](advanced-topics/switching-versions.md)

    * [Working with Enterprise](advanced-topics/working-with-enterprise/README.md)

        * [How to configure private Alfresco Nexus repository](advanced-topics/working-with-enterprise/enterprise-mvn-repo.md)

        * [How to configure private Alfresco Docker registry](advanced-topics/working-with-enterprise/enterprise-docker-registry.md)

        * [How to set up Alfresco Transform Service](advanced-topics/working-with-enterprise/alfresco-transform-service.md)

    * [Working with AMPs](advanced-topics/amps.md)

    * Debugging

        * [Remote debugging using Eclipse](debug-eclipse.md)

        * [Remote debugging using IntelliJ](debug-intellij.md)

    * [Integration testing](integration-testing.md)

        * [How SDK's integration tests work](it-working.md)

        * [How to run SDK's integration tests](it-running.md)

        * [Remote debugging using Eclipse](advanced-topics/debugging/debug-eclipse.md)

        * [Remote debugging using IntelliJ](advanced-topics/debugging/debug-intellij.md)

    * [Integration testing](advanced-topics/integration-testing/README.md)

        * [How SDK's integration tests work](advanced-topics/integration-testing/it-working.md)

        * [How to run SDK's integration tests](advanced-topics/integration-testing/it-running.md)

    * Hot reloading

        * [How to configure and use JRebel](jrebel.md)

        * [How to configure and use Hotswap Agent](hotswap-agent.md)

        * [How to configure and use JRebel](advanced-topics/hot-reloading/jrebel.md)

        * [How to configure and use Hotswap Agent](advanced-topics/hot-reloading/hotswap-agent.md)

* [Troubleshooting](troubleshooting.md)

docs/amps.md→docs/advanced-topics/amps.md

+0 −0

File moved.

View file

docs/debug-eclipse.md→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](./imgs/sdk-debug-eclipse-create.png?raw=true "Eclipse remote debug create configuration")

![Alt text](../../docassets/images/sdk-debug-eclipse-create.png?raw=true "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](./imgs/sdk-debug-eclipse-config.png?raw=true "Eclipse remote debug configuration detail")

![Alt text](../../docassets/images/sdk-debug-eclipse-config.png?raw=true "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](./imgs/sdk-debug-eclipse-launch.png?raw=true "Eclipse remote debug configuration launch")

![Alt text](../../docassets/images/sdk-debug-eclipse-launch.png?raw=true "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](./imgs/sdk-hellofromjava.png?raw=true "Hello World webscript original result")

![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "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](./imgs/sdk-debug-eclipse-breakpoint.png?raw=true "Eclipse remote debug stopped at breakpoint")

![Alt text](../../docassets/images/sdk-debug-eclipse-breakpoint.png?raw=true "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/debug-intellij.md→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](./imgs/sdk-debug-intellij-create.png?raw=true "IntelliJ remote debug create configuration")

![Alt text](../../docassets/images/sdk-debug-intellij-create.png?raw=true "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](./imgs/sdk-debug-intellij-config.png?raw=true "IntelliJ remote debug configuration detail")

![Alt text](../../docassets/images/sdk-debug-intellij-config.png?raw=true "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](./imgs/sdk-debug-intellij-launch.png?raw=true "IntelliJ remote debug configuration launch")

![Alt text](../../docassets/images/sdk-debug-intellij-launch.png?raw=true "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](./imgs/sdk-hellofromjava.png?raw=true "Hello World webscript original result")

![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "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](./imgs/sdk-debug-intellij-breakpoint.png?raw=true "IntelliJ remote debug stopped at breakpoint")

![Alt text](../../docassets/images/sdk-debug-intellij-breakpoint.png?raw=true "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/hotswap-agent.md→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](./imgs/sdk-hellofromjava.png?raw=true "Hello World webscript original result")

![Alt text](../../docassets/images/sdk-hellofromjava.png?raw=true "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](./imgs/sdk-hellofromme.png?raw=true "Hello World webscript modified result")

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



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