Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-7858] Simplify references to Alfresco SDKs #1567

Merged
merged 3 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions _data/toc/content-services.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
path: '/content-services/latest/develop/software-architecture/'
- title: 'Software Development Kits (SDK)'
pages:
- title: 'In-Process SDK (4.7, 4.8)'
- title: 'In-Process SDK'
path: '/content-services/latest/develop/sdk/'
- title: 'Out-of-Process SDK (6.x)'
path: '/content-services/latest/develop/oop-sdk/'
Expand Down Expand Up @@ -631,9 +631,9 @@
path: '/content-services/7.4/develop/software-architecture/'
- title: 'Software Development Kits (SDK)'
pages:
- title: 'In-Process SDK (4.6)'
- title: 'In-Process SDK'
path: '/content-services/7.4/develop/sdk/'
- title: 'Out-of-Process SDK (5.2)'
- title: 'Out-of-Process SDK'
path: '/content-services/7.4/develop/oop-sdk/'
- title: 'Extension packaging (modules)'
path: '/content-services/7.4/develop/extension-packaging/'
Expand Down Expand Up @@ -949,9 +949,9 @@
path: '/content-services/7.3/develop/software-architecture/'
- title: 'Software Development Kits (SDK)'
pages:
- title: 'In-Process SDK (4.5)'
- title: 'In-Process SDK'
path: '/content-services/7.3/develop/sdk/'
- title: 'Out-of-Process SDK (5.2)'
- title: 'Out-of-Process SDK'
path: '/content-services/7.3/develop/oop-sdk/'
- title: 'Extension packaging (modules)'
path: '/content-services/7.3/develop/extension-packaging/'
Expand Down Expand Up @@ -1267,9 +1267,9 @@
path: '/content-services/7.2/develop/software-architecture/'
- title: 'Software Development Kits (SDK)'
pages:
- title: 'In-Process SDK (4.4)'
- title: 'In-Process SDK'
path: '/content-services/7.2/develop/sdk/'
- title: 'Out-of-Process SDK (5.1)'
- title: 'Out-of-Process SDK'
path: '/content-services/7.2/develop/oop-sdk/'
- title: 'Extension packaging (modules)'
path: '/content-services/7.2/develop/extension-packaging/'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,4 +231,4 @@ The Event Gateway provides a ReST API with the following features:
An out-of-process extension may create a subscription to receive certain types of events in a specific topic of an
ActiveMQ broker.

For more information on how to use the subscription API see the [SDK 5 documentation]({% link content-services/7.2/develop/oop-sdk.md %}#using-event-gateway).
For more information on how to use the subscription API, see the [Event Gateway documentation]({% link content-services/7.2/develop/oop-sdk.md %}#using-event-gateway).
4 changes: 2 additions & 2 deletions content-services/7.2/develop/oop-ext-points/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Overview of out-of-process platform extension points

Out-of-process Platform Extensions are extensions that run outside the Alfresco servers in its own processes.

The new [event system]({% link content-services/7.2/develop/oop-ext-points/events.md %}) in Content Services 7 enables
The [event system]({% link content-services/7.2/develop/oop-ext-points/events.md %}) introduced in Content Services 7 enables
out-of-process extensions. To support the event system a [ReST API Java Wrapper]({% link content-services/7.2/develop/oop-ext-points/rest-api-java-wrapper.md %})
is provided for easy development of extensions from Java applications.

You should get familiar with the [SDK 5]({% link content-services/7.2/develop/oop-sdk.md %}) as it is
You should get familiar with the [Out-of-Process SDK]({% link content-services/7.2/develop/oop-sdk.md %}) as it is
the recommended way of developing out-of-process extensions.

Read through the [Getting started guide]({% link content-services/7.2/develop/index.md %}) to get up to
Expand Down
6 changes: 3 additions & 3 deletions content-services/7.2/develop/overview-ext-points.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ so called *Extension Points*. An extension point is a supported interface that c
The extension points can be divided into Out-of-process extension points and In-process extension points.

## Out-of-process extension points
The new [event system]({% link content-services/7.2/develop/oop-ext-points/events.md %}) in Content Services 7 enables
The [event system]({% link content-services/7.2/develop/oop-ext-points/events.md %}) introduced in Content Services 7 enables
out-of-process extensions. To support the event system a [ReST API Java Wrapper]({% link content-services/7.2/develop/oop-ext-points/rest-api-java-wrapper.md %})
is provided for easy development of extensions from Java applications.

You should get familiar with the [SDK 5]({% link content-services/7.2/develop/oop-sdk.md %}) as it is
You should get familiar with the [Out-of-Process SDK]({% link content-services/7.2/develop/oop-sdk.md %}) as it is
the recommended way of developing out-of-process extensions.

## In-process extension points
The in-process extension points can be divided further into server side extensions for the Platform, also referred to as
Repository, and UI extensions for the web client called Share. To get started see [Platform extensions overview]({% link content-services/7.2/develop/repo-ext-points/index.md %})
and [Share extensions overview]({% link content-services/7.2/develop/share-ext-points/index.md %}).

Also, you should get familiar with [SDK 4]({% link content-services/7.2/develop/sdk.md %}) as it is
Also, you should get familiar with the [In-Process SDK]({% link content-services/7.2/develop/sdk.md %}) as it is
the recommended way of developing in-process extensions.

24 changes: 13 additions & 11 deletions content-services/7.2/develop/sdk.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Alfresco SDK 4.4 for in-process extensions
title: Alfresco In-Process SDK for in-process extensions
---

Alfresco SDK 4.4 is a Maven based development kit that provides an easy to use approach to developing applications and
The Alfresco In-Process SDK is a Maven based development kit that provides an easy to use approach to developing applications and
extensions for Alfresco. With this SDK you can develop, package, test, run, document and release your Alfresco extension project.

The following picture illustrates where SDK 4.x fits into the big picture:
The following picture illustrates where the In-Process SDK fits into the big picture:

![sdk4_big_picture]({% link content-services/images/sdk4_big_picture.png %})

Expand All @@ -17,12 +17,12 @@ and Test Driven Development (TDD).
The Alfresco SDK is released under [Apache License version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html){:target="_blank"}
and supports Content Services both in Community Edition and Enterprise Edition. If you're an Enterprise customer,
check the [Alfresco SDK Support status]({% link content-services/7.2/support/index.md %})
for the version you're using. If your version is in Limited or Full Support and you need help, contact our [Support team](https://support.alfresco.com/){:target="_blank"}.
for the version you're using. If your version is in Limited or Full Support and you need help, [contact Support]({% link support/latest/contact.md %}).

The 4.0 release took advantage of Semantic Versioning ([SEMVER](https://semver.org/){:target="_blank"}), which means
that it isn't directly compatible with the previous releases of the SDK.

If you have existing projects that you wish to upgrade to SDK 4.4 the recommended approach is to generate a new project
If you have existing projects that you wish to upgrade to the latest SDK version, the recommended approach is to generate a new project
from the new archetypes and move your code into place.

## What's new?
Expand All @@ -41,7 +41,7 @@ Adding, removing and configuring services in the environment is as easy as modif
[Java 11](https://openjdk.java.net/projects/jdk/11/){:target="_blank"} is the next Long Term Support (LTS) version that provides support for 3 years. Alfresco 6.1+ already offers
support for this version of the Java platform.

Alfresco SDK 4.0 has been modified to add support for Java 11 as well. This way, if you're working as a developer in customizations for Alfresco 6.1 or later, you must now use SDK 4.0 + JDK 11 to work on them. The Apache Maven plugins included in the archetypes has been updated to avoid any issue with Java 11.
Alfresco SDK 4.0 has been modified to add support for Java 11 as well. If you're working as a developer on customizations for Content Services, you must now use the latest version of the SDK + JDK 11 to work on them. The Apache Maven plugins included in the archetypes has been updated to avoid any issue with Java 11.

### Easy dependency configuration
The configuration of the Maven dependency management has been greatly improved thanks to the addition of a _bill of materials_ (BOM).
Expand Down Expand Up @@ -209,6 +209,8 @@ Alfresco recommends that you keep up-to-date with all the Docker releases. If yo
16: 4.4.0
```

This example uses SDK 4.4, but you should see similar results for other SDK 4.x versions.

4. Next you will be prompted for additional values, like `groupId`, `artifactId`, and `package`, as shown below:

```bash
Expand Down Expand Up @@ -326,7 +328,7 @@ Please note that the numbering is not sequential and some numbers may be skipped
### org.alfresco.maven.archetype:alfresco-allinone-archetype

This archetype allows a developer to implement the All-In-One project on Content Services. The All-In-One project (also called AIO) is provided in
this and previous versions of Alfresco SDK, but in SDK 4.x it has been reshaped to leverage on Docker.
this and previous versions of Alfresco SDK. It has been reshaped in SDK 4 to leverage Docker.

The All-In-One archetype allows a developer to create a multi-module project on Content Services. The All-In-One project mainly includes a module for
the core repository in ACS and a module for the Share client. This includes:
Expand All @@ -351,7 +353,7 @@ For more information about the All-In-One project, see [All-In-One project struc

### org.alfresco.maven.archetype:alfresco-platform-jar-archetype

This archetype allows a developer to implement the Platform JAR project on Content Services. It has been reshaped in SDK 4.x to leverage on Docker.
This archetype allows a developer to implement the Platform JAR project on Content Services. It has been reshaped in SDK 4 to leverage Docker.

The Platform JAR Maven archetype allows a developer to create a module on Content Services, in particular on the Repository side, and includes:

Expand All @@ -370,7 +372,7 @@ For more information about the Platform JAR project, see [Platform JAR project s

### org.alfresco.maven.archetype:alfresco-share-jar-archetype

This archetype allows a developer to implement the Share JAR project on an Alfresco Share client. It has been reshaped in SDK 4.x to leverage on Docker.
This archetype allows a developer to implement the Share JAR project on an Alfresco Share client. It has been reshaped in SDK 4 to leverage Docker.

The Share JAR Maven archetype allows a developer to create a module on an Alfresco Share client, and includes:

Expand Down Expand Up @@ -1712,10 +1714,10 @@ If you want more detail about how to work with the project, visit [Working with

### 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
The Maven Alfresco SDK is designed to work well with Intellij. 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
Here we assume you already have an Intellij 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](#gettingstarted) to learn how to quickly generate it in a few
easy steps.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,4 +231,4 @@ The Event Gateway provides a ReST API with the following features:
An out-of-process extension may create a subscription to receive certain types of events in a specific topic of an
ActiveMQ broker.

For more information on how to use the subscription API see the [SDK 5 documentation]({% link content-services/7.3/develop/oop-sdk.md %}#using-event-gateway).
For more information on how to use the subscription API, see the [Event Gateway documentation]({% link content-services/7.3/develop/oop-sdk.md %}#using-event-gateway).
4 changes: 2 additions & 2 deletions content-services/7.3/develop/oop-ext-points/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Overview of out-of-process platform extension points

Out-of-process Platform Extensions are extensions that run outside the Alfresco servers in its own processes.

The new [event system]({% link content-services/7.3/develop/oop-ext-points/events.md %}) in Content Services 7 enables
The [event system]({% link content-services/7.3/develop/oop-ext-points/events.md %}) introduced in Content Services 7 enables
out-of-process extensions. To support the event system a [ReST API Java Wrapper]({% link content-services/7.3/develop/oop-ext-points/rest-api-java-wrapper.md %})
is provided for easy development of extensions from Java applications.

You should get familiar with the [SDK 5]({% link content-services/7.3/develop/oop-sdk.md %}) as it is
You should get familiar with the [Out-of-Process SDK]({% link content-services/7.3/develop/oop-sdk.md %}) as it is
the recommended way of developing out-of-process extensions.

Read through the [Getting started guide]({% link content-services/7.3/develop/index.md %}) to get up to
Expand Down
6 changes: 3 additions & 3 deletions content-services/7.3/develop/overview-ext-points.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ so called *Extension Points*. An extension point is a supported interface that c
The extension points can be divided into Out-of-process extension points and In-process extension points.

## Out-of-process extension points
The new [event system]({% link content-services/7.3/develop/oop-ext-points/events.md %}) in Content Services 7 enables
The [event system]({% link content-services/7.3/develop/oop-ext-points/events.md %}) introduced in Content Services 7 enables
out-of-process extensions. To support the event system a [ReST API Java Wrapper]({% link content-services/7.3/develop/oop-ext-points/rest-api-java-wrapper.md %})
is provided for easy development of extensions from Java applications.

You should get familiar with the [SDK 5]({% link content-services/7.3/develop/oop-sdk.md %}) as it is
You should get familiar with the [Out-of-Process SDK]({% link content-services/7.3/develop/oop-sdk.md %}) as it is
the recommended way of developing out-of-process extensions.

## In-process extension points
The in-process extension points can be divided further into server side extensions for the Platform, also referred to as
Repository, and UI extensions for the web client called Share. To get started see [Platform extensions overview]({% link content-services/7.3/develop/repo-ext-points/index.md %})
and [Share extensions overview]({% link content-services/7.3/develop/share-ext-points/index.md %}).

Also, you should get familiar with [SDK 4]({% link content-services/7.3/develop/sdk.md %}) as it is
Also, you should get familiar with the [In-Process SDK]({% link content-services/7.3/develop/sdk.md %}) as it is
the recommended way of developing in-process extensions.

Loading