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

maven site various fixes, mostly links

Browse Source 
git-svn-id: http://maven-alfresco-archetypes.googlecode.com/svn/trunk@637 04253f4f-3451-0410-a141-5562f1e59037
This commit is contained in:
maoo
2012-11-04 23:43:15 +00:00
parent 830df696c5
commit dc1b95cb08
19 changed files with 122 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,17 +6,17 @@
Nov 2012
------
Alfresco SDK Parent - Part of Maven Alfresco SDK\x99
Introduction
The Alfresco SDK Parent POM ${project.version} is the <<<single entry point>>> for all Maven 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 {{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} here}}.
The current version of the POM in use in the Maven Alfresco SDK\x99 ${project.version} is available {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}on Alfresco Maven Repository}}.
Usage
You can reference Alfresco SDK POM in your POM adding the following snippet:
+---+
<project>
...
@@ -33,9 +33,9 @@ Usage
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
{{{./sdk-properties}POM properties}} avaialble to sibling projects.
{{{./sdk-properties.html}POM properties}} avaialble to sibling projects.
* 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 <Projects using this POM> or the {{{/index.html}SDK Home Page}} for more samples.
Check the menu item <SDK Components> for more samples.

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

@@ -10,28 +10,31 @@ SDK Available Profiles
The Maven 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}AMP}} and {{{./archetypes/alfresco-allinone-archetype/index.html}All-in-One}} archetypes),
{{{../../archetypes/alfresco-amp-archetype/index.html}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.
Here goes the list of common used profiles (with their activation conditions):
*-----------+--------------+-------------+-------------+
|| Profile || Description || Activation | |Phase |
|| Profile || Description || Activation || Phase |
*-----------+--------------+-------------+-------------+
| amp-to-war | Allows AMP projects to be run embedded on a WAR | Manual: <<<-Pamp-to-war>>> | integration-test |
*-----------*--------------*-------------*-------------*
| purge | Cleans all alf_data and logs from Alfresco runs | Manual: <<<-Ppurge>>> | clean |
*-----------*--------------*-------------*-------------*
| enable-amp-testing | Allows AMP unit testing | Automatic if <<<src/test/java>>> is present | test |
*-----------*--------------*-------------*-------------*
| enable-amp | Activates AMP packaging | Automatic if <<<src/main/amp/modules.properties>>> is present | test |
*-----------+--------------+-------------+-------------+
The full list of available profiles (with their activation conditions) can be instead found in the <<<profiles>>> section of the
{{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} <20>lfresco 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
The full reference of properties defined in the SDK can be obtained by looking
at the <<<properties>>> section of the current version of the <<<alfresco-sdk-parent>>> in use.
Check the {{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} current POM version}} for this.
Check the {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}current POM version}} for this.
While in certain cases it might be useful to override defaults, make sure you know what you're doing,
as you might be <<breaking>> SDK conventions and therefore <<your build>>>

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

@@ -39,7 +39,23 @@ Full SDK properties reference
The full reference of properties defined in the SDK can be obtained by looking
at the <<<properties>>> section of the current version of the <<<alfresco-sdk-parent>>> in use.
Check the {{{${scm.tags.url}/poms/alfresco-sdk-parent/pom.xml} current POM version}} for this.
Check the {{{https://artifacts.alfresco.com/nexus/index.html#nexus-search;gav~org.alfresco.maven~alfresco-sdk-parent~${project.version}~pom~}current POM version}} for this.
While in certain cases it might be useful to override defaults, make sure you know what you're doing,
as you might be <<breaking>> SDK conventions and therefore <<your build>>>
as you might be <<breaking>> SDK conventions and therefore <<your build>>>
Example - Configuring custom DB
In order to configure a given JDBC database connection, you need to define some POM properties.
+---+
<properties>
...
<alfresco.db.name>alfresco</alfresco.db.name>
<alfresco.db.username>alfresco</alfresco.db.username>
<alfresco.db.password>alfresco</alfresco.db.password>
<alfresco.db.params></alfresco.db.params>
<alfresco.db.url>jdbc:mysql://${db.host}:${db.port}/${db.name}</alfresco.db.url>
<alfresco.db.datasource.class>org.gjt.mm.mysql.Driver</alfresco.db.datasource.class>
</properties>
+---+

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

@@ -33,32 +33,25 @@
<body>
<menu ref="modules" inherit="bottom"/>
<!--<menu ref="modules" inherit="bottom"/>-->
<menu ref="parent" inherit="bottom"/>
<menu name="Maven Alfresco SDK Parent POM">
<menu name="SDK Parent POM">
<item name="Introduction" href="./index.html" />
<item name="Maven Alfresco SDK Properties" href="./sdk-properties.html" />
<item name="Maven Alfresco SDK Profiles" href="./sdk-profiles.html" />
</menu>
<menu name="Projects using this POM">
<menu name="SDK components">
<item name="Maven Alfresco SDK" href="../../index.html" />
<item name="Alfresco AMP Archetype" href="../../archetypes/alfresco-amp-archetype/index.html" />
<item name="Alfresco All-in-One Archetype" href="../../archetypes/alfresco-allinone-archetype/index.html" />
</menu>
<menu name="Maven Alfresco SDK">
<item name="Home" href="/index.html" />
<item name="Maven Alfresco SDK Prerequisites" href="../../prerequisites.html" />
<item name="Maven Alfresco SDK Properties" href="../../poms/alfresco-sdk-parent/sdk-properties.html" />
<item name="Why using SDK?" href="../../why.html" />
<item name="Alfresco SDK Parent POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html" />
<item name="Alfresco SDK Parent POM" href="./index.html" />
<item name="Alfresco Platform Distribution POM" href="https://artifacts.alfresco.com/nexus/content/repositories/alfresco-docs/alfresco-platform-distribution/latest/index.html" />
<item name="Maven AMP Plugin" href="http://maven.alfresco.com/nexus/content/repositories/alfresco-docs/maven-alfresco-lifecycle/latest/plugins/maven-amp-plugin/index.html" />
<item name="Alfresco Maven Plugin" href="../../plugins/alfresco-maven-plugin/index.html" />
</menu>
<menu name="Maven Alfresco Community">
<item name="Alfresco Maven Wiki Docs" href="http://wiki.alfresco.com/wiki/Maven_Alfresco_SDK" />
<item name="Alfresco with Maven for Dummies" href="https://wiki.alfresco.com/wiki/Maven_For_Dummies" />
@@ -70,10 +63,5 @@
</menu>
<menu ref="reports" />
<links>
<item name="Alfresco" href="http://www.alfresco.com/" />
<item name="Apache Maven" href="http://maven.apache.org/" />
</links>
</body>
</project>