mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-07-31 17:39:14 +00:00
Documentation - Update root README file
This commit is contained in:
19
README.md
19
README.md
@@ -1,6 +1,8 @@
|
|||||||
# [](#features) Alfresco SDK
|
# [](#features) Alfresco SDK
|
||||||
|
|
||||||
This is the home of the Alfresco SDK. The Alfresco SDK is used by developers to build extensions for the Alfresco Digital Business Platform. It is based on [Apache Maven](http://maven.apache.org/), compatible with major IDEs and enables Rapid Application Development (RAD) and Test Driven Development (TDD).
|
This is the home of the Alfresco SDK. The Alfresco SDK is used by developers to build extensions for the Alfresco Digital Business Platform. It is based on
|
||||||
|
[Apache Maven](http://maven.apache.org/), compatible with major IDEs and enables [Rapid Application Development (RAD)](https://en.wikipedia.org/wiki/Rapid_application_development)
|
||||||
|
and [Test Driven Development (TDD)](https://en.wikipedia.org/wiki/Test-driven_development).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license.
|
This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license.
|
||||||
@@ -8,6 +10,7 @@ If you are an Enterprise customer check the [Support](#alfresco-enterprise-custo
|
|||||||
|
|
||||||
## News
|
## News
|
||||||
|
|
||||||
|
- 2019-XX-XX: Alfresco SDK 4.0.0 released **(confirmation required)**
|
||||||
- 2017-06-23: Alfresco SDK 3.0.1 released, [containing a critical bugfix](https://github.com/Alfresco/alfresco-sdk/issues/461)
|
- 2017-06-23: Alfresco SDK 3.0.1 released, [containing a critical bugfix](https://github.com/Alfresco/alfresco-sdk/issues/461)
|
||||||
- 2017-04-01: Alfresco SDK 3.0.0 released
|
- 2017-04-01: Alfresco SDK 3.0.0 released
|
||||||
- 2017-03-27: After years of hard work, countless iterations and gathering feedback, SDK 3.0 has finally been merged into the master branch, ready for release in the coming days
|
- 2017-03-27: After years of hard work, countless iterations and gathering feedback, SDK 3.0 has finally been merged into the master branch, ready for release in the coming days
|
||||||
@@ -21,11 +24,12 @@ If you are an Enterprise customer check the [Support](#alfresco-enterprise-custo
|
|||||||
## User Getting Started
|
## User Getting Started
|
||||||
|
|
||||||
### Latest Documentation
|
### Latest Documentation
|
||||||
To get started with **Alfresco SDK 4.0.x** (latest) visit the [Alfresco Documentation](https://docs.alfresco.com/6.0/concepts/dev-for-developers.html) (documentation pending).
|
To get started with **Alfresco SDK 4.0.x** (latest) visit the [Alfresco Documentation](docs/README.md).
|
||||||
|
|
||||||
#### Documentation about Previous Versions
|
#### Documentation about Previous Versions
|
||||||
| SDK Version | Alfresco Enterprise Version | Alfresco Community Version | Documentation |
|
| SDK Version | Alfresco Enterprise Version | Alfresco Community Version | Documentation |
|
||||||
| ------------- |:-------------:| :-----:|:-----|
|
| ------------- |:-------------:| :-----:|:-----|
|
||||||
|
| SDK 4.0 | Alfresco 6.0.x / 6.1.x | Alfresco 6.0.x / 6.1.x | https://master--alfresco-builder-network.netlify.com **(confirmation required)** |
|
||||||
| SDK 3.0 | Alfresco 5.2.x | Alfresco 5.2.x | http://docs.alfresco.com/5.2/concepts/sdk-intro.html |
|
| SDK 3.0 | Alfresco 5.2.x | Alfresco 5.2.x | http://docs.alfresco.com/5.2/concepts/sdk-intro.html |
|
||||||
| SDK 2.2 | Alfresco 5.1.x | Alfresco 5.1.x | https://docs.alfresco.com/5.1/concepts/alfresco-sdk-intro.html |
|
| SDK 2.2 | Alfresco 5.1.x | Alfresco 5.1.x | https://docs.alfresco.com/5.1/concepts/alfresco-sdk-intro.html |
|
||||||
| SDK 2.1 | Alfresco 5.0.1 | Alfresco 5.0.d | https://docs.alfresco.com/sdk2.1/concepts/alfresco-sdk-intro.html |
|
| SDK 2.1 | Alfresco 5.0.1 | Alfresco 5.0.d | https://docs.alfresco.com/sdk2.1/concepts/alfresco-sdk-intro.html |
|
||||||
@@ -43,12 +47,13 @@ please check the [SDK Support status](http://www.alfresco.com/services/subscript
|
|||||||
for the version you are using. If your version is in Limited or Full Support and you need help, visit the [Support Portal](http://support.alfresco.com).
|
for the version you are using. If your version is in Limited or Full Support and you need help, visit the [Support Portal](http://support.alfresco.com).
|
||||||
|
|
||||||
## Maven repositories
|
## Maven repositories
|
||||||
- As of version 2.0-beta-1, The Alfresco SDK is released in [Maven Central](http://search.maven.org/#search|ga|1|alfresco-sdk). Previous versions are available in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/).
|
- As of version 2.0-beta-1, The Alfresco SDK is released in [Maven Central](http://search.maven.org/#search|ga|1|alfresco-sdk). Previous versions are available
|
||||||
|
in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/).
|
||||||
- Alfresco (Community and Enterprise) artifacts are hosted in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/).
|
- Alfresco (Community and Enterprise) artifacts are hosted in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/).
|
||||||
- Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publicly available.
|
- Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publicly available.
|
||||||
|
|
||||||
*NOTE:* By default the Alfresco SDK will use Community Edition releases but it can be configured to use Enterprise Edition releases. Enterprise and Premier customers can use the SDK with
|
*NOTE:* By default the Alfresco SDK will use Community Edition releases but it can be configured to use Enterprise Edition releases. Enterprise and Premier
|
||||||
Enterprise Edition releases by following the process described in [Working with Enterprise](https://docs.alfresco.com/5.2/concepts/sdk-using-enterprise.html)
|
customers can use the SDK with Enterprise Edition releases by following the process described in [Working with Enterprise](docs/advanced-topics/working-with-enterprise/README.md).
|
||||||
|
|
||||||
### Alfresco Artifacts Repository
|
### Alfresco Artifacts Repository
|
||||||
|
|
||||||
@@ -72,5 +77,9 @@ To test new unreleased (unsupported) features, you can use the following snippet
|
|||||||
</repository>
|
</repository>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Docker registries
|
||||||
|
- Alfresco Community Docker images are publicly available at the [Alfresco's Docker Hub profile](https://hub.docker.com/u/alfresco/).
|
||||||
|
- Alfresco Enterprise Docker images are hosted at [Quay.io](https://quay.io/). Its configuration process is described in detail in [How to configure private Alfresco Docker registry](docs/advanced-topics/working-with-enterprise/enterprise-docker-registry.md).
|
||||||
|
|
||||||
## For Developers that want to contribute to the SDK
|
## For Developers that want to contribute to the SDK
|
||||||
See the [Developers Wiki page](https://github.com/Alfresco/alfresco-sdk/wiki/Developer-Wiki).
|
See the [Developers Wiki page](https://github.com/Alfresco/alfresco-sdk/wiki/Developer-Wiki).
|
||||||
|
@@ -10,4 +10,4 @@ application server. This section outlines the steps needed to configure Alfresco
|
|||||||
and to troubleshoot issues by stepping through the code line by line.
|
and to troubleshoot issues by stepping through the code line by line.
|
||||||
|
|
||||||
Here we assume you have already generated an Alfresco project using the Alfresco SDK. If you don't have a project already, follow the steps in
|
Here we assume you have already generated an Alfresco project using the Alfresco SDK. If you don't have a project already, follow the steps in
|
||||||
[Getting started with Alfresco SDK 3.0](../../getting-started.md) to learn how to generate it in a few easy steps.
|
[Getting started with Alfresco SDK 4.0](../../getting-started.md) to learn how to generate it in a few easy steps.
|
||||||
|
@@ -18,6 +18,7 @@ When editing `pom.xml` you will see a number of properties that define the Alfre
|
|||||||
<alfresco.platform.version>6.0.7-ga</alfresco.platform.version>
|
<alfresco.platform.version>6.0.7-ga</alfresco.platform.version>
|
||||||
<alfresco.share.version>6.0.c</alfresco.share.version>
|
<alfresco.share.version>6.0.c</alfresco.share.version>
|
||||||
```
|
```
|
||||||
|
**(confirmation required)**
|
||||||
|
|
||||||
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.
|
||||||
|
Reference in New Issue
Block a user