mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-07-31 17:39:14 +00:00
Documentation - Reorganise documentation content
Reorganise the documentation content to fix the required folder structure and file naming for the migration to ABN.
This commit is contained in:
Jose Luis Osorno
@@ -31,27 +31,27 @@ code into place.
|
|||||||
* [What's new?]() **TODO**
|
* [What's new?]() **TODO**
|
||||||
* [Getting started with Alfresco SDK 4.0](getting-started.md)
|
* [Getting started with Alfresco SDK 4.0](getting-started.md)
|
||||||
* [Alfresco SDK Maven archetypes](mvn-archetypes.md)
|
* [Alfresco SDK Maven archetypes](mvn-archetypes.md)
|
||||||
* [Working with generated projects](projects-usage.md)
|
* [Working with generated projects](working-with-generated-projects/README.md)
|
||||||
* [All-In-One project structure](structure-aio.md)
|
* [All-In-One project structure](working-with-generated-projects/structure-aio.md)
|
||||||
* [Platform JAR project structure](structure-platform.md)
|
* [Platform JAR project structure](working-with-generated-projects/structure-platform.md)
|
||||||
* [Share JAR project structure](structure-share.md)
|
* [Share JAR project structure](working-with-generated-projects/structure-share.md)
|
||||||
* Setting up your development environment
|
* Setting up your development environment
|
||||||
* [Setting up your development environment using Eclipse](dev-env-eclipse.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](dev-env-intellij.md)
|
* [Setting up your development environment using Intellij IDEA](setting-up-your-development-environment/dev-env-intellij.md)
|
||||||
* Advanced topics
|
* Advanced topics
|
||||||
* [Switching Alfresco Content Services and Share versions](switching-versions.md)
|
* [Switching Alfresco Content Services and Share versions](advanced-topics/switching-versions.md)
|
||||||
* [Working with Enterprise](enterprise.md)
|
* [Working with Enterprise](advanced-topics/working-with-enterprise/README.md)
|
||||||
* [How to configure private Alfresco Nexus repository](enterprise-mvn-repo.md)
|
* [How to configure private Alfresco Nexus repository](advanced-topics/working-with-enterprise/enterprise-mvn-repo.md)
|
||||||
* [How to configure private Alfresco Docker registry](enterprise-docker-registry.md)
|
* [How to configure private Alfresco Docker registry](advanced-topics/working-with-enterprise/enterprise-docker-registry.md)
|
||||||
* [How to set up Alfresco Transform Service](alfresco-transform-service.md)
|
* [How to set up Alfresco Transform Service](advanced-topics/working-with-enterprise/alfresco-transform-service.md)
|
||||||
* [Working with AMPs](amps.md)
|
* [Working with AMPs](advanced-topics/amps.md)
|
||||||
* Debugging
|
* Debugging
|
||||||
* [Remote debugging using Eclipse](debug-eclipse.md)
|
* [Remote debugging using Eclipse](advanced-topics/debugging/debug-eclipse.md)
|
||||||
* [Remote debugging using IntelliJ](debug-intellij.md)
|
* [Remote debugging using IntelliJ](advanced-topics/debugging/debug-intellij.md)
|
||||||
* [Integration testing](integration-testing.md)
|
* [Integration testing](advanced-topics/integration-testing/README.md)
|
||||||
* [How SDK's integration tests work](it-working.md)
|
* [How SDK's integration tests work](advanced-topics/integration-testing/it-working.md)
|
||||||
* [How to run SDK's integration tests](it-running.md)
|
* [How to run SDK's integration tests](advanced-topics/integration-testing/it-running.md)
|
||||||
* Hot reloading
|
* Hot reloading
|
||||||
* [How to configure and use JRebel](jrebel.md)
|
* [How to configure and use JRebel](advanced-topics/hot-reloading/jrebel.md)
|
||||||
* [How to configure and use Hotswap Agent](hotswap-agent.md)
|
* [How to configure and use Hotswap Agent](advanced-topics/hot-reloading/hotswap-agent.md)
|
||||||
* [Troubleshooting](troubleshooting.md)
|
* [Troubleshooting](troubleshooting.md)
|
||||||
@@ -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).
|
1. Open the Eclipse IDE and click on `Run Configurations` (top right).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. Click on the green plus sign (top left) and select `Remote Java Application` to add a new configuration for a remote app.
|
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`.
|
3. Enter a descriptive name for your configuration, for example, `Sample project ACS debug`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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.
|
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.
|
7. Click on the bug icon and select the new configuration to run it.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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.
|
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.
|
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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,
|
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.
|
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:
|
10. Refresh the browser. Eclipse will intercept the execution at the 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
|
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.
|
at debug time, thanks to the local maven repository.
|
||||||
@@ -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).
|
1. Open the IntelliJ IDEA IDE and click on `Add/Edit Configurations` (top right).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. Click on the plus icon (top left) and select `Remote` to add a new configuration for a remote app.
|
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`.
|
3. Enter a descriptive name for your configuration, for example, `Sample project ACS debug`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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
|
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.
|
6. Click on the `Edit Configurations` dropdown box and select the new configuration to run it.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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.
|
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.
|
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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,
|
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.
|
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:
|
9. Refresh the browser. IntelliJ IDEA will intercept the execution at the 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
|
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.
|
at debug time, thanks to the local maven repository.
|
||||||
@@ -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.
|
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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).
|
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:
|
6. Refresh the browser to see the updated message:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
By changing the code and compiling it again, the changes have been dynamically received from Alfresco Content Services.
|
By changing the code and compiling it again, the changes have been dynamically received from Alfresco Content Services.
|
||||||
@@ -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.
|
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`.
|
6. Give a descriptive name to the new server and set the `Server URL` as `http://localhost:8080/alfresco`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
7. Select the checkbox to enable the server synchronisation and the checkbox to `Synchronize on build`.
|
7. Select the checkbox to enable the server synchronisation and the checkbox to `Synchronize on build`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
8. Select `Help > JRebel > Configuration > Projects` and select the checkbox to enable JRebel and the remote server support for required projects (the complete
|
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).
|
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).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Installing JRebel using IntelliJ IDEA
|
## 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.
|
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.
|
6. Give a descriptive name to the new server and set the `Server URL` as `http://localhost:8080/alfresco.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
7. Select the checkbox to enable the server synchronisation and the checkbox to `Synchronize on build`.
|
7. Select the checkbox to enable the server synchronisation and the checkbox to `Synchronize on build`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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).
|
Platform Jar archetype or the `PROJECT_ARTIFACT_ID-platform-jar` and `integration-tests` modules in case of the All-In-One archetype).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Configuring JRebel in the project
|
## 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.
|
This is a sample webscript generated in every project created using SDK 4.0 and the platform artifact.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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).
|
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:
|
6. Refresh the browser to see the updated message:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
By changing the code and compiling it again, the changes have been dynamically received from Alfresco Content Services.
|
By changing the code and compiling it again, the changes have been dynamically received from Alfresco Content Services.
|
||||||
@@ -78,16 +78,16 @@ the `build_start` or the `start` goal of the `run` script.
|
|||||||
|
|
||||||
4. Right click and select `Run As ...`, then click `JUnit Test`.
|
4. Right click and select `Run As ...`, then click `JUnit Test`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Once the tests have completed (typically, after a few seconds), the results are presented.
|
Once the tests have completed (typically, after a few seconds), the results are presented.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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
|
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
|
||||||
Alfresco Content Services with every change, use **hot reloading** as the only way to deploy the new version of the Java classes. For more details, see
|
Alfresco Content Services with every change, use **hot reloading** as the only way to deploy the new version of the Java classes. For more details, see
|
||||||
[JRebel](jrebel.md) / [HotSwapAgent](hotswap-agent.md) Hot reloading.
|
[JRebel](../hot-reloading/jrebel.md) / [HotSwapAgent](../hot-reloading/hotswap-agent.md) Hot reloading.
|
||||||
|
|
||||||
## IntelliJ IDEA IDE
|
## IntelliJ IDEA IDE
|
||||||
|
|
||||||
@@ -104,13 +104,13 @@ the `build_start` or the `start` goal of the `run` script.
|
|||||||
|
|
||||||
4. Right click and select `Run Tests`.
|
4. Right click and select `Run Tests`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Once the tests have completed (typically, after a few seconds), the results are presented.
|
Once the tests have completed (typically, after a few seconds), the results are presented.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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
|
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
|
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
|
||||||
Alfresco Content Services with every change, use **hot reloading** as the only way to deploy the new version of the Java classes. For more details, see
|
Alfresco Content Services with every change, use **hot reloading** as the only way to deploy the new version of the Java classes. For more details, see
|
||||||
[JRebel](jrebel.md) / [HotSwapAgent](hotswap-agent.md) Hot reloading.
|
[JRebel](../hot-reloading/jrebel.md) / [HotSwapAgent](../hot-reloading/hotswap-agent.md) Hot reloading.
|
||||||
@@ -22,7 +22,7 @@ When editing `pom.xml` you will see a number of properties that define the Alfre
|
|||||||
Before continuing, always remember to start from a newly generated SDK project before changing the version numbers. We do not recommend changing the versions
|
Before continuing, always remember to start from a newly generated SDK project before changing the version numbers. We do not recommend changing the versions
|
||||||
using developed customizations or source code.
|
using developed customizations or source code.
|
||||||
|
|
||||||
This article is focused on the Community version. If you want to switch to Alfresco Enterprise, please visit [Working with Enterprise](enterprise.md).
|
This article is focused on the Community version. If you want to switch to Alfresco Enterprise, please visit [Working with Enterprise](working-with-enterprise/README.md).
|
||||||
|
|
||||||
The supported versions are explained in the next sections of this article.
|
The supported versions are explained in the next sections of this article.
|
||||||
|
|
||||||
@@ -55,5 +55,5 @@ $ ./run.sh build_start
|
|||||||
```
|
```
|
||||||
|
|
||||||
**IMPORTANT:** Alfresco 6.1 is ready to work with JDK 11, but Alfresco 6.0 needs to be compiled and run using JDK 8, so please take this into account when you
|
**IMPORTANT:** Alfresco 6.1 is ready to work with JDK 11, but Alfresco 6.0 needs to be compiled and run using JDK 8, so please take this into account when you
|
||||||
switch from version 6.1.x to 6.0.x. If you compile Alfresco 6.0.x with JDK 11 you'll experience the issue described in the [Troubleshooting page](troubleshooting.md)
|
switch from version 6.1.x to 6.0.x. If you compile Alfresco 6.0.x with JDK 11 you'll experience the issue described in the [Troubleshooting page](../troubleshooting.md)
|
||||||
about wrong JDK versions.
|
about wrong JDK versions.
|
||||||
@@ -116,5 +116,3 @@ messaging.broker.url=failover:(nio://activemq:61616)?timeout=3000&jms.useCompres
|
|||||||
|
|
||||||
Once these 2 modifications are done, rebuild and restart all the services (`run.sh/run.bat build_start`) and ACS will use ATS to execute remote transformations
|
Once these 2 modifications are done, rebuild and restart all the services (`run.sh/run.bat build_start`) and ACS will use ATS to execute remote transformations
|
||||||
asynchronously whenever possible.
|
asynchronously whenever possible.
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 320 KiB After Width: | Height: | Size: 320 KiB |
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 113 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 368 KiB After Width: | Height: | Size: 368 KiB |
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 7.3 KiB After Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 146 KiB After Width: | Height: | Size: 146 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 175 KiB After Width: | Height: | Size: 175 KiB |
|
Before Width: | Height: | Size: 203 KiB After Width: | Height: | Size: 203 KiB |
|
Before Width: | Height: | Size: 467 KiB After Width: | Height: | Size: 467 KiB |
|
Before Width: | Height: | Size: 260 KiB After Width: | Height: | Size: 260 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
@@ -199,4 +199,4 @@ In the terminal window, use:
|
|||||||
If this is the first time you are doing this, it will take a while for Maven to download all the required dependencies and for Docker to download all the
|
If this is the first time you are doing this, it will take a while for Maven to download all the required dependencies and for Docker to download all the
|
||||||
required images.
|
required images.
|
||||||
|
|
||||||
For more information about how to work with the projects, please visit [Working with generated projects](projects-usage.md).
|
For more information about how to work with the projects, please visit [Working with generated projects](working-with-generated-projects/README.md).
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ The All-In-One project is recommended to be used if you have to develop a custom
|
|||||||
customizations on Alfresco Share client. If your plan to develop a project on the Alfresco Content Services Repository only, use the Platform JAR Maven
|
customizations on Alfresco Share client. If your plan to develop a project on the Alfresco Content Services Repository only, use the Platform JAR Maven
|
||||||
archetype. If you plan to develop a project on the Alfresco Share client only, use the Share JAR Maven archetype.
|
archetype. If you plan to develop a project on the Alfresco Share client only, use the Share JAR Maven archetype.
|
||||||
|
|
||||||
For more information about the All-In-One project, see [All-In-One project structure](structure-aio.md).
|
For more information about the All-In-One project, see [All-In-One project structure](working-with-generated-projects/structure-aio.md).
|
||||||
|
|
||||||
### org.alfresco.maven.archetype:alfresco-platform-jar-archetype
|
### org.alfresco.maven.archetype:alfresco-platform-jar-archetype
|
||||||
|
|
||||||
@@ -95,7 +95,7 @@ Services Repository. The samples included in the project are basic and straightf
|
|||||||
The Platform JAR project is recommended to be used if you have to develop a customization of the Alfresco Content Services Repository. If you also plan to
|
The Platform JAR project is recommended to be used if you have to develop a customization of the Alfresco Content Services Repository. If you also plan to
|
||||||
develop a customization of the Alfresco Share client, use the All-In-One Maven archetype instead.
|
develop a customization of the Alfresco Share client, use the All-In-One Maven archetype instead.
|
||||||
|
|
||||||
For more information about the Platform JAR project, see [Platform JAR project structure](structure-platform.md).
|
For more information about the Platform JAR project, see [Platform JAR project structure](working-with-generated-projects/structure-platform.md).
|
||||||
|
|
||||||
### org.alfresco.maven.archetype:alfresco-share-jar-archetype
|
### org.alfresco.maven.archetype:alfresco-share-jar-archetype
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ The samples included in the project are basic and straightforward, and can help
|
|||||||
The Share JAR project is recommended to be used if you have to develop a customization of the Alfresco Share client. If you also plan to develop a
|
The Share JAR project is recommended to be used if you have to develop a customization of the Alfresco Share client. If you also plan to develop a
|
||||||
customization of the Alfresco Content Services Repository, use the All-In-One Maven archetype instead.
|
customization of the Alfresco Content Services Repository, use the All-In-One Maven archetype instead.
|
||||||
|
|
||||||
For more information about the Share JAR project, see [Share JAR project structure](structure-share.md).
|
For more information about the Share JAR project, see [Share JAR project structure](working-with-generated-projects/structure-share.md).
|
||||||
|
|
||||||
### org.alfresco.maven.archetype:activiti-jar-archetype (for use with SDK 2.2 only)
|
### org.alfresco.maven.archetype:activiti-jar-archetype (for use with SDK 2.2 only)
|
||||||
|
|
||||||
|
|||||||
@@ -9,18 +9,18 @@ The Maven Alfresco SDK is designed to work well with Eclipse. This support inclu
|
|||||||
Alfresco SDK.
|
Alfresco SDK.
|
||||||
|
|
||||||
Here we assume you already have an Eclipse installation up and running, together with an available Alfresco project created using the Alfresco SDK. If you
|
Here we assume you already have an Eclipse installation up and running, together with an available Alfresco project created using the Alfresco SDK. If you
|
||||||
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.0](getting-started.md) to learn how to quickly generate it in a few
|
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.0](../getting-started.md) to learn how to quickly generate it in a few
|
||||||
easy steps.
|
easy steps.
|
||||||
|
|
||||||
## Importing the Alfresco project into Eclipse
|
## Importing the Alfresco project into Eclipse
|
||||||
|
|
||||||
1. Starting from Eclipse, select `File > Import > Maven > Existing Maven Projects` from the main menu to import the Alfresco project.
|
1. Starting from Eclipse, select `File > Import > Maven > Existing Maven Projects` from the main menu to import the Alfresco project.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. Click `Next` then browse to the root of the Alfresco project.
|
2. Click `Next` then browse to the root of the Alfresco project.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. Click `Finish` to start importing the project into Eclipse.
|
3. Click `Finish` to start importing the project into Eclipse.
|
||||||
|
|
||||||
@@ -29,14 +29,14 @@ required dependencies, this task will finish relatively quickly. Otherwise, be p
|
|||||||
|
|
||||||
Once the import is complete, a warning message may be displayed.
|
Once the import is complete, a warning message may be displayed.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
4. Click `Resolve All Later` to complete the import task.
|
4. Click `Resolve All Later` to complete the import task.
|
||||||
|
|
||||||
5. Check the Markers tab in the bottom panel, where you may see some Maven problems. Expand the list and right click on a item with an error, then select
|
5. Check the Markers tab in the bottom panel, where you may see some Maven problems. Expand the list and right click on a item with an error, then select
|
||||||
`Quick Fix` and mark as shown.
|
`Quick Fix` and mark as shown.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
6. Click `Finish` to confirm the fix.
|
6. Click `Finish` to confirm the fix.
|
||||||
|
|
||||||
@@ -51,4 +51,4 @@ and then click `OK`.
|
|||||||
|
|
||||||
Once this is done, the project is successfully imported in Eclipse.
|
Once this is done, the project is successfully imported in Eclipse.
|
||||||
|
|
||||||
If you want more detail about how to work with the project, please visit [Working with generated projects](projects-usage.md).
|
If you want more detail about how to work with the project, please visit [Working with generated projects](../working-with-generated-projects/README.md).
|
||||||
@@ -9,7 +9,7 @@ The Maven Alfresco SDK is designed to work well with Eclipse. This support inclu
|
|||||||
Alfresco SDK.
|
Alfresco SDK.
|
||||||
|
|
||||||
Here we assume you already have an Eclipse installation up and running, together with an available Alfresco project created using the Alfresco SDK. If you
|
Here we assume you already have an Eclipse installation up and running, together with an available Alfresco project created using the Alfresco SDK. If you
|
||||||
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.0](getting-started.md) to learn how to quickly generate it in a few
|
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.0](../getting-started.md) to learn how to quickly generate it in a few
|
||||||
easy steps.
|
easy steps.
|
||||||
|
|
||||||
## Importing the Alfresco project into Intellij IDEA
|
## Importing the Alfresco project into Intellij IDEA
|
||||||
@@ -17,12 +17,12 @@ easy steps.
|
|||||||
1. Starting from IntelliJ IDEA, select `File > Open` from the main menu to open the Alfresco project. Alternatively, select `Import Project` if you're running
|
1. Starting from IntelliJ IDEA, select `File > Open` from the main menu to open the Alfresco project. Alternatively, select `Import Project` if you're running
|
||||||
IntelliJ IDEA for the first time in your development environment.
|
IntelliJ IDEA for the first time in your development environment.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. After the project is imported, you will see a window similar to the following:
|
2. After the project is imported, you will see a window similar to the following:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Once this is done, the project is successfully imported in IntelliJ IDEA.
|
Once this is done, the project is successfully imported in IntelliJ IDEA.
|
||||||
|
|
||||||
If you want more detail about how to work with the project, please visit [Working with generated projects](projects-usage.md).
|
If you want more detail about how to work with the project, please visit [Working with generated projects](../working-with-generated-projects/README.md).
|
||||||
@@ -146,6 +146,3 @@ That allows you to modify the number of the exposed ports through maven properti
|
|||||||
```
|
```
|
||||||
|
|
||||||
That way, if you face a port conflict, you only need to change the port in the corresponding maven property and rebuilt and restart the project.
|
That way, if you face a port conflict, you only need to change the port in the corresponding maven property and rebuilt and restart the project.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,9 +18,9 @@ a great quantity of training resources about [Docker](https://docs.docker.com/ge
|
|||||||
|
|
||||||
After generating your project, using one of the Maven archetypes, review the project structure. The directory structure and content of each folder and file
|
After generating your project, using one of the Maven archetypes, review the project structure. The directory structure and content of each folder and file
|
||||||
can help you to understand how to start developing with the Alfresco SDK 4.0. Before continuing, make sure that you have read and completed the tasks in the
|
can help you to understand how to start developing with the Alfresco SDK 4.0. Before continuing, make sure that you have read and completed the tasks in the
|
||||||
[Getting started](getting-started.md) tutorial.
|
[Getting started](../getting-started.md) tutorial.
|
||||||
|
|
||||||
The structure of the project and the purpose of the files it contains vary according to the [Maven archetype](mvn-archetypes.md) used to generate the project
|
The structure of the project and the purpose of the files it contains vary according to the [Maven archetype](../mvn-archetypes.md) used to generate the project
|
||||||
itself. The following links provide detailed descriptions of the different project types.
|
itself. The following links provide detailed descriptions of the different project types.
|
||||||
|
|
||||||
* [All-In-One project structure](structure-aio.md)
|
* [All-In-One project structure](structure-aio.md)
|
||||||
@@ -183,7 +183,7 @@ Below is a description of the files in the root of the project (in this case, `m
|
|||||||
|
|
||||||
File | Description
|
File | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
`run` (`sh` and `bat`) | Utility script to work with the project (compile, run, test, show logs, etc.). For detailed information about it, check [Working with generated projects](projects-usage.md).
|
`run` (`sh` and `bat`) | Utility script to work with the project (compile, run, test, show logs, etc.). For detailed information about it, check [Working with generated projects](README.md).
|
||||||
`pom.xml` | This XML file contains information about the project and configuration details used by Apache Maven to build the project. You can define all the configurations, parameters, and settings in this file for projects as well as for sub-projects.
|
`pom.xml` | This XML file contains information about the project and configuration details used by Apache Maven to build the project. You can define all the configurations, parameters, and settings in this file for projects as well as for sub-projects.
|
||||||
`README.md` | File in Markdown format containing the documentation for the project.
|
`README.md` | File in Markdown format containing the documentation for the project.
|
||||||
|
|
||||||
@@ -95,7 +95,7 @@ Below is a description of the files in the root of the project (in this case, `m
|
|||||||
|
|
||||||
File | Description
|
File | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
`run` (`sh` and `bat`) | Utility script to work with the project (compile, run, test, show logs, etc.). For detailed information about it, check [Working with generated projects](projects-usage.md).
|
`run` (`sh` and `bat`) | Utility script to work with the project (compile, run, test, show logs, etc.). For detailed information about it, check [Working with generated projects](README.md).
|
||||||
`pom.xml` | This XML file contains information about the project and configuration details used by Apache Maven to build the project.
|
`pom.xml` | This XML file contains information about the project and configuration details used by Apache Maven to build the project.
|
||||||
`README.md` | File in Markdown format containing the documentation for the project.
|
`README.md` | File in Markdown format containing the documentation for the project.
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ Below is a description of the files in the root of the project (in this case, `m
|
|||||||
|
|
||||||
File | Description
|
File | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
`run` (`sh` and `bat`) | Utility script to work with the project (compile, run, test, show logs, etc.). For detailed information about it, check [Working with generated projects](projects-usage.md).
|
`run` (`sh` and `bat`) | Utility script to work with the project (compile, run, test, show logs, etc.). For detailed information about it, check [Working with generated projects](README.md).
|
||||||
`pom.xml` | This XML file contains information about the project and configuration details used by Apache Maven to build the project.
|
`pom.xml` | This XML file contains information about the project and configuration details used by Apache Maven to build the project.
|
||||||
`README.md` | File in Markdown format containing the documentation for the project.
|
`README.md` | File in Markdown format containing the documentation for the project.
|
||||||
|
|
||||||
@@ -108,5 +108,5 @@ Content | Description
|
|||||||
`src/main/resources/alfresco/module/<artifactId>` | This folder contains all the configuration files and settings for the Alfresco Share module. Here you can find the property file for the module.
|
`src/main/resources/alfresco/module/<artifactId>` | This folder contains all the configuration files and settings for the Alfresco Share module. Here you can find the property file for the module.
|
||||||
`src/main/resources/alfresco/web-extension` | In this folder you can find the extensions to the web client (Alfresco Share) and it's where you store Spring configurations that extend and override the system Share configuration. There are two important sub-directories here: `site-data` and `site-webscripts`.
|
`src/main/resources/alfresco/web-extension` | In this folder you can find the extensions to the web client (Alfresco Share) and it's where you store Spring configurations that extend and override the system Share configuration. There are two important sub-directories here: `site-data` and `site-webscripts`.
|
||||||
`src/main/resources/alfresco/META-INF/resources` | This folder hosts the content that will be placed in the `META-INF` folder of a standard Java web application. It is best practice to use a further subdirectory based on the module name. This allows you to manage multiple modules, so that their web resources don't conflict with each other.
|
`src/main/resources/alfresco/META-INF/resources` | This folder hosts the content that will be placed in the `META-INF` folder of a standard Java web application. It is best practice to use a further subdirectory based on the module name. This allows you to manage multiple modules, so that their web resources don't conflict with each other.
|
||||||
`src/main/resources/alfresco/META-INF/share-config-custom.xml` | This file is a relevant Alfresco Share file used to configure the sub-project with the correct settings, depending on your environment. For more details, see [Share configuration](http://docs.alfresco.com/5.2/concepts/dev-extensions-share-configuration.html).
|
`src/main/resources/alfresco/META-INF/share-config-custom.xml` | This file is a relevant Alfresco Share file used to configure the sub-project with the correct settings, depending on your environment. For more details, see [Share configuration](http://docs.alfresco.com/6.0/concepts/dev-extensions-share-configuration.html).
|
||||||
`src/test/java/<groupId>...` | This folder contains the same content you can find in a regular Java project, i.e. the Java source code for tests. Here you should put all the custom classes, interfaces, and Java source code related to tests.
|
`src/test/java/<groupId>...` | This folder contains the same content you can find in a regular Java project, i.e. the Java source code for tests. Here you should put all the custom classes, interfaces, and Java source code related to tests.
|
||||||
Reference in New Issue
Block a user