inteligr8/alfresco-sdk
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-sdk.git synced 2025-07-31 17:39:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Reorganise documentation content

Browse Source 
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
2019-01-17 11:32:21 +01:00
parent 0027ef3ec4
commit ccee83f92d
49 changed files with 67 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/setting-up-your-development-environment/dev-env-eclipse.md Normal file
View File

@@ -0,0 +1,54 @@
---
Title: Setting up your development environment using Eclipse
Added: v3.0.0
Last reviewed: 2019-01-14
---
# Setting up your development environment using Eclipse
The Maven Alfresco SDK is designed to work well with Eclipse. This support includes the ability to import existing Alfresco projects created using the
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
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.
## 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.
![Alt text](../docassets/images/sdk-dev-env-eclipse-import.png?raw=true "Eclipse maven project import")
2. Click `Next` then browse to the root of the Alfresco project.
![Alt text](../docassets/images/sdk-dev-env-eclipse-project.png?raw=true "Eclipse maven project selection")
3. Click `Finish` to start importing the project into Eclipse.
Before completing the import, Eclipse checks the completeness of the local Maven repository. If you already have a local repository that includes all the
required dependencies, this task will finish relatively quickly. Otherwise, be patient and wait until the downloads are completed (it can take some time).
Once the import is complete, a warning message may be displayed.
![Alt text](../docassets/images/sdk-dev-env-eclipse-warning.png?raw=true "Eclipse maven project import warning")
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
`Quick Fix` and mark as shown.
![Alt text](../docassets/images/sdk-dev-env-eclipse-quickfix.png?raw=true "Eclipse maven project import quick fix")
6. Click `Finish` to confirm the fix.
You may be asked to confirm your selection.
7. Repeat the fix for all similar issues you have. Note that these issues really depend on the archetype you used to generate the project.
Once done, you may see an error with description: Project configuration is not up-to-date with pom.xml.
8. To fix this, right click one of the Alfresco projects and select `Maven > Update Project`, ensure all the Alfresco projects and sub-projects are selected,
and then click `OK`.
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](../working-with-generated-projects/README.md).

28
docs/setting-up-your-development-environment/dev-env-intellij.md Normal file
View File

@@ -0,0 +1,28 @@
---
Title: Setting up your development environment using Intellij IDEA
Added: v3.0.0
Last reviewed: 2019-01-14
---
# Setting up your development environment using Intellij IDEA
The Maven Alfresco SDK is designed to work well with Eclipse. This support includes the ability to import existing Alfresco projects created using the
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
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.
## Importing the Alfresco project into Intellij IDEA
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.
![Alt text](../docassets/images/sdk-dev-env-intellij-import.png?raw=true "IntelliJ maven project import")
2. After the project is imported, you will see a window similar to the following:
![Alt text](../docassets/images/sdk-dev-env-intellij-finish.png?raw=true "IntelliJ maven project imported")
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](../working-with-generated-projects/README.md).