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

Tune generated doc (mostly Maven Alfresco SDK -> Alfresco SDK)

Browse Source
This commit is contained in:
Samuel Langlois
2014-12-18 18:06:56 +00:00
parent 6493b8e9d1
commit f5a4787964
16 changed files with 63 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,4 +1,4 @@
# [![Maven Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Maven Alfresco SDK
# [![Alfresco SDK logo](https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg)](#features) Alfresco SDK
SDK for Alfresco Development, Testing, packaging and custom project lifecycle management based on Apache Maven.
@@ -20,15 +20,15 @@ The SDK is composed of:
### Developer Documentation
**SDK 2.x**: Full documentation is available at the [Maven Alfresco SDK site](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html).
**SDK 2.x**: Full documentation is available at the [Alfresco SDK site](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html).
### Alfresco Official Documentation
Additional documentation for Alfresco Community and Enterprise, tutorials and examples is available in the [Alfresco Documentation](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html).
Additional documentation for Alfresco Community and Enterprise, tutorials and examples is available in the [Alfresco Documentation](http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html).
### Samples
Advanced sample projects are maintained by @ohej in the [Maven Alfresco SDK Samples project](https://github.com/Alfresco/alfresco-sdk-samples/).
Advanced sample projects are maintained by @ohej in the [Alfresco SDK Samples project](https://github.com/Alfresco/alfresco-sdk-samples/).
### Contribute
@@ -37,7 +37,7 @@ Report issues (and contribute!) [here](https://github.com/Alfresco/alfresco-sdk/
## Maven Repositories
The Maven Alfresco SDK is released in Maven Central as of version 2.0-beta-1.
The Alfresco SDK is released in Maven Central as of version 2.0-beta-1.
Alfresco (Community and Enterprise) artifacts are instead hosted in the [Alfresco Artifacts Repository](https://artifacts.alfresco.com/nexus/).
@@ -46,7 +46,7 @@ Alfresco Community artifacts (JARs, WARs, AMPs, poms) and SDK artifacts are publ
for Enterprise and Premiere licensed software access you need to get credential via the Alfresco Enterprise Support. See [public docs](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-tutorials-alfresco-enterprise.html) or [this KB (login required)](https://myalfresco.force.com/support/articles/en_US/Technical_Article/Where-can-I-find-the-repository-for-Enterprise-Maven-artifacts) for more details.
## License and Support
This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). It's a community driven project which is supported for Alfresco Development (please refere to the official [Alfresco Documentation](http://docs.alfresco.com/4.2/concepts/dev-extensions-maven-sdk-intro.html) for supported features.
This project is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). It's a community driven project which is supported for Alfresco Development (please refere to the official [Alfresco Documentation](http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html) for supported features.
## News

4
archetypes/alfresco-allinone-archetype/src/site/apt/advanced-usage.apt.vm
View File

@@ -9,7 +9,7 @@
All-in-One Archetype properties
In each of the modules of the archetype (as in the whole Maven Alfresco SDK\x99) properties are configurable at many levels:
In each of the modules of the archetype (as in the whole Alfresco SDK\x99) properties are configurable at many levels:
* as POM properties
@@ -36,4 +36,4 @@ Parent POM and behavior customization
To customize the behavior of your project, check out full set of the properties and plugin configurations defined in the
{{{./poms/alfresco-sdk-parent/index.html}single entry point parent POM}}.
One quick way to do that is to use the <<<maven-help-plugin:effective-pom>>> to analyze your POM at runtime.
One quick way to do that is to use the <<<maven-help-plugin:effective-pom>>> to analyze your POM at runtime.

8
archetypes/alfresco-allinone-archetype/src/site/apt/index.apt.vm
View File

@@ -9,7 +9,7 @@
Introduction
The Alfresco All-in-One Archetype is a multi-module project,
leveraging Maven Alfresco SDK\x99 powerful capabilities to customize and run the full Alfresco platform embedded and all it's components.
leveraging Alfresco SDK\x99 powerful capabilities to customize and run the full Alfresco platform embedded and all it's components.
The archetype does not require additional download and provides a perfect starting point for full-blown Alfresco projects.
* Features
@@ -31,18 +31,18 @@ How to create a project:
As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central:
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:alfresco-allinone-archetype
+---+
For previous versions, you need to use the Alfresco Artifacts repository:
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:alfresco-allinone-archetype -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
+---+
You should then:
[[1]] Select the <<<alfresco-allinone-archetype>>> option
[[1]] Select the <<<alfresco-allinone-archetype>>> version
[[2]] Specify the <<<groupId>>> and <<<artifactId>>> for the project you want to create

6
archetypes/alfresco-amp-archetype/src/site/apt/index.apt.vm
View File

@@ -36,18 +36,18 @@ How to create a project:
As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central:
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:alfresco-amp-archetype
+---+
For previous versions, you need to use the Alfresco Artifacts repository:
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:alfresco-amp-archetype -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
+---+
You should then:
[[1]] Select the <<<alfresco-amp-archetype>>> option
[[1]] Select the <<<alfresco-amp-archetype>>> version
[[2]] Specify the <<<groupId>>> and <<<artifactId>>> for the project you want to create

4
archetypes/share-amp-archetype/src/main/resources/archetype-resources/src/site/apt/advanced-usage.apt.vm
View File

@@ -16,7 +16,7 @@ AMP Unit Testing
Share AMP Archetype properties
In the AMP archetype (as in the whole Part of the Maven Alfresco SDK\x99) properties are configurable at many levels:
In the AMP archetype (as in the whole Part of the Alfresco SDK\x99) properties are configurable at many levels:
* as POM properties
@@ -59,4 +59,4 @@ Parent POM and behavior customization
{{{../../poms/alfresco-sdk-parent/index.html}single entry point parent POM}}.
One quick way to do that is to use the <<<maven-help-plugin:effective-pom>>> to analyze your POM at runtime.

6
archetypes/share-amp-archetype/src/site/apt/index.apt.vm
View File

@@ -32,17 +32,17 @@ How to create a project:
As of version 2.0-beta-3, you can create a project with the latest released archetype with the following command directly from Maven Central:
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=http://repo1.maven.org/maven2/archetype-catalog.xml
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:share-amp-archetype
+---+
For previous versions, you need to use the Alfresco Artifacts repository:
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:share-amp-archetype -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
+---+
You should then:
[[1]] Select the <<<share-amp-archetype>>> option
[[1]] Select the <<<share-amp-archetype>>> version
[[2]] Specify the <<<groupId>>> and <<<artifactId>>> for the project you want to create

2
plugins/alfresco-maven-plugin/pom.xml
View File

@@ -93,7 +93,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<version>3.2</version>
<version>3.3</version>
</plugin>
</plugins>
</reporting>

12
plugins/alfresco-maven-plugin/src/site/apt/usage.apt.vm
View File

@@ -10,13 +10,13 @@ How to use this plugin?
There are fundamentally 3 methods to use this plugin:
[[1]] Using Archetypes provided in the Maven Alfresco SDK
[[1]] Using Archetypes provided in the Alfresco SDK
[[2]] By using the Maven Alfresco SDK Parent POM
[[2]] By using the Alfresco SDK Parent POM
[[3]] Via direct configuration in your POM
* Method 1 - Using Maven Alfresco SDK Archetypes
* Method 1 - Using Alfresco SDK Archetypes
Two sample archetypes already use the plugin and provide best practice example on how to use it:
@@ -27,9 +27,9 @@ How to use this plugin?
This is the <<recommended>> and less error-prone way of using the plugin.
* Method 2 - Using Maven Alfresco SDK Parent POM
* Method 2 - Using Alfresco SDK Parent POM
The {{{../../poms/alfresco-sdk-parent/index.html}Maven Alfresco SDK Parent POM}} provides a single entry point for all SDK features.
The {{{../../poms/alfresco-sdk-parent/index.html}Alfresco SDK Parent POM}} provides a single entry point for all SDK features.
By using it as parent as follows:
@@ -96,4 +96,4 @@ How to use this plugin?
</build>
[...]
</project>
+---+
+---+

10
poms/alfresco-sdk-parent/src/site/apt/index.apt.vm
View File

@@ -8,14 +8,14 @@
Introduction
The Maven Alfresco SDK Parent POM ${project.version} is the <<<single entry point>>> for all Maven Alfresco SDK\x99 features.
The Alfresco SDK Parent POM ${project.version} is the <<<single entry point>>> for all Alfresco SDK\x99 features.
It aggregates plugin configurations and dependencies to provide a set of profiles and properties to manage the full Alfresco projects Lifecycle on Maven.
The current version of the POM in use in the Maven Alfresco SDK\x99 ${project.version} is available {{{https://oss.sonatype.org/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}on Maven Central}}.
The current version of the POM in use in the Alfresco SDK\x99 ${project.version} is available {{{https://oss.sonatype.org/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}on Maven Central}}.
Usage
You can reference Maven Alfresco SDK POM in your POM adding the following snippet:
You can reference Alfresco SDK POM in your POM adding the following snippet:
+---+
<project>
@@ -29,7 +29,7 @@ Usage
</project>
+---+
This will reference the Maven Alfresco SDK project as <<<parent>>> project, allowing you to inherit all SDK features.
This will reference the Alfresco SDK project as <<<parent>>> project, allowing you to inherit all SDK features.
Full dependency information for other build systems can be found in the {{{./dependency-info.html} Dependency Info page}}.
Features are provided in terms of {{{./sdk-profiles.html} Maven profiles}}, and high configurability is provided with
@@ -38,4 +38,4 @@ Usage
* Examples / archetypes
To kickstart your SDK experience and to provide examples on how to use it, archetypes are available already using this POM.
Check the menu item <SDK Components> for more samples.
Check the menu item <SDK Components> for more samples.

6
poms/alfresco-sdk-parent/src/site/apt/sdk-profiles.apt.vm
View File

@@ -1,5 +1,5 @@
------
Maven Alfresco SDK\x99 Profiles
Alfresco SDK\x99 Profiles
------
Gabriele Columbro
------
@@ -8,7 +8,7 @@
SDK Available Profiles
The Maven Alfresco SDK\x99 defines common features required by different Alfresco projects.
The Alfresco SDK\x99 defines common features required by different Alfresco projects.
While the <<<recommended>>> way is to use full working examples of usage of these profiles (e.g. the
{{{../../archetypes/alfresco-amp-archetype/index.html}Repo AMP}}, {{{../../archetypes/share-amp-archetype/index.html}Share AMP} and {{{../../archetypes/alfresco-allinone-archetype/index.html}All-in-One}} archetypes),
you can also directly use this POM as a parent in your custom project.
@@ -38,7 +38,7 @@ SDK Available Profiles
The full list of available profiles (with their activation conditions) can be instead found in the <<<profiles>>> section of the
{{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}Maven Alfresco SDK POM}}.
{{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}Alfresco SDK POM}}.
Full SDK properties reference

4
poms/alfresco-sdk-parent/src/site/apt/sdk-properties.apt.vm
View File

@@ -1,5 +1,5 @@
------
Maven Alfresco SDK Properties
Alfresco SDK Properties
------
Gabriele Columbro
------
@@ -20,7 +20,7 @@ Common SDK properties
-->
<properties>
<alfresco.groupId>org.alfresco</alfresco.groupId>
<alfresco.version>4.2.b</alfresco.version>
<alfresco.version>5.0.c</alfresco.version>
<!-- Defines root logger log level for testing and embedded run -->
<app.log.root.level>WARN</app.log.root.level>
<!-- Logging dir. Note the trailing slash is required -->

2
poms/alfresco-sdk-parent/src/site/site.xml
View File

@@ -2,7 +2,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>1.3.0</version>
<version>1.3.1</version>
</skin>
<custom>

26
src/site/apt/index.apt.vm
View File

@@ -1,5 +1,5 @@
------
Maven Alfresco SDK\x99
Alfresco SDK\x99
------
Gabriele Columbro
------
@@ -8,24 +8,24 @@
Introduction
The (Maven) Maven Alfresco SDK\x99 - formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html} Alfresco Lifecycle 3.9.1}} -
The Alfresco SDK\x99 - formerly Maven Alfresco SDK\x99, formerly {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/index.html} Alfresco Lifecycle 3.9.1}} -
provides a fully fledged Maven support for {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project development.
Being fully integrated with Maven it allows to both leverage the vast number of Maven plugins for your Alfresco project as well as integrated your
project easily in Open Source and Enterprise development processes.
The Maven Alfresco SDK\x99 is fully documented in the single components websites (see menu above).
The Alfresco SDK\x99 is fully documented in the single components websites (see menu above).
For official (Enterprise) support of this SDK please refer to the features and tutorials documented in {{{http://docs.alfresco.com/community/concepts/alfresco-sdk-intro.html}the Official Alfresco Documentation}}.
How to Use the SDK
The easiest way to use the SDK is to create a sample project using one of the available <<archetypes>> (Repo AMP, Share AMP, All in One).
You can also use the Maven Alfresco SDK Parent POM directly in your Maven project to inherit Alfresco behaviors and configurations.
You can also use the Alfresco SDK Parent POM directly in your Maven project to inherit Alfresco behaviors and configurations.
SDK Versions
As of version 2.0, releases for the Maven Alfresco SDK are available in Maven Central.
As of version 2.0, releases for the Alfresco SDK are available in Maven Central.
Maven Alfresco SDK 1.x versions rely on the {{{https://artifacts.alfresco.com/nexus/content/groups/public/}Alfresco Artifacts Repository}}.
For documentation on the Maven Alfresco SDK\x99 1.x please refer to {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/index.html} Maven Alfresco SDK 1.x}}
@@ -35,14 +35,20 @@ SDK Alfresco Compatibility
Please refer to the {{{http://docs.alfresco.com/community/concepts/alfresco-sdk-compatibility.html}official Alfresco docs}} for details of SDK / Alfresco compatibility.
Maven Alfresco SDK\x99 components
Alfresco SDK\x99 components
The Maven Alfresco SDK relies on a number of components:
The Alfresco SDK relies on a number of components:
* {{{./poms/alfresco-sdk-parent/index.html}The SDK parent POM}} providing full Alfresco project lifecycle feature, to be added as a <<<<parent>>>> in your projects
* Archetypes like the {{{./archetypes/alfresco-amp-archetype/index.html}Repo AMP}}, {{{./archetypes/share-amp-archetype/index.html}Share AMP}} or {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} providing sample project to kickstart your Alfresco development and boost it with best practices
* Archetypes providing sample project to kickstart your Alfresco development and boost it with best practices
* the {{{./archetypes/alfresco-amp-archetype/index.html}Repo AMP}}, a single project that customizes Alfresco Repository
* the {{{./archetypes/share-amp-archetype/index.html}Share AMP}}, a single project that customizes Alfresco Share
* the {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}}, a multi-module project to customize and run all components
* The {{{./plugins/alfresco-maven-plugin/index.html} Maven Alfresco Plugin}} to manage AMP packaging and dependencies
* {{{https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest}Alfresco Platform Distribution POM}} can (optionally) be used to provide centralized <<<<dependencyManagement>>>> on a particular Alfresco version / edition (Community / Enterprise)
@@ -79,4 +85,4 @@ Project History
* The new Maven Alfresco SDK 1.0 is released and presented on Tuesday 7 November at {{{http://devcon.alfresco.com/}Alfresco DevCon}} in Berlin.
* The new Maven Alfresco SDK 2.0 is released and presented on late 2014 November and released on Maven Central
* The new Alfresco SDK 2.0 is released and presented on late 2014 November and released on Maven Central

8
src/site/apt/prerequisites.apt.vm
View File

@@ -1,5 +1,5 @@
------
Maven Alfresco SDK Prerequisites
Alfresco SDK Prerequisites
------
Gabriele Columbro
------
@@ -7,10 +7,10 @@
------
Maven Alfresco SDK\x99 Pre-Requisites
Alfresco SDK\x99 Pre-Requisites
The only real prerequisite of the Maven Alfresco SDK\x99 Apache Maven 3.0.4 installed (and properly configured) on your machine;
The only real prerequisite of the Alfresco SDK\x99 Apache Maven 3.0.4 installed (and properly configured) on your machine;
neither <<an IDE>> nor <<web container or database>> are required.
Additional tips:
@@ -46,7 +46,7 @@ H2 Embedded Support Pre-Requisites
the open source effort {{{https://github.com/skuro/alfresco-h2-support} Alfresco H2 Support}}. This bridge allows to emulate
Alfresco expected DB behavior and is therefore very specific to every Alfresco version.
Maven Alfresco SDK\x99 ${project.version} uses version 1.5 of the Alfresco H2 Support. In case you experience
Alfresco SDK\x99 ${project.version} uses version 1.5 of the Alfresco H2 Support. In case you experience
issues with the embedded DB support, please check the {{{https://github.com/skuro/alfresco-h2-support/wiki/H2-Database-support-for-Alfresco} H2 Support Compatibility matrix}}.
Alternatively, you can easily setup your DB access by defining {{{./poms/alfresco-sdk-parent/sdk-properties.html}POM properties}}

8
src/site/apt/why.apt.vm
View File

@@ -8,14 +8,14 @@
Rationale
The Maven Alfresco SDK introduces a new way of conceiving software development, deployment and release of Alfresco related projects and artifacts.
The Alfresco SDK introduces a new way of conceiving software development, deployment and release of Alfresco related projects and artifacts.
In contrast to the manual (and error prone) deployment approach based on an installer / Alfresco WAR distribution(s) and the <infamous> <<<${extensionRoot}>>>,
the Maven Alfresco SDK provides a unified access to fine grained Artifacts (jar,war,pom files),] that can be easily integrated
the Alfresco SDK provides a unified access to fine grained Artifacts (jar,war,pom files),] that can be easily integrated
in your project by the means of Alfresco-specific Maven components and configurations. The main goal of this SDK is to
enable rapid development and prototyping of Alfresco projects, while enabling agile development practices (i.e. TDD, FDD)
and fostering process reuse due to standardization
Why would you use the Maven Alfresco SDK\x99?
Why would you use the Alfresco SDK\x99?
As a standard de facto, Maven allows you projects to be inherently more reusable and enables <process reuse> of your development practices,
and, in certain successful cases, Application Lifecycle Management process at large.
@@ -43,4 +43,4 @@ Why would you use the Maven Alfresco SDK\x99?
* One mvn command to generate, one mvn command to run embedded, this is all you need to do to have a local Alfresco running on an empty laptop
* Supports community and enterprise seamlessly, allowing to switch one between versions / edition easily.
* Supports community and enterprise seamlessly, allowing to switch one between versions / edition easily.

2
src/site/site.xml
View File

@@ -2,7 +2,7 @@
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>1.3.0</version>
<version>1.3.1</version>
</skin>
<custom>
<fluidoSkin>