Commit 2d6eec00 authored by mindthegab's avatar mindthegab
Browse files

-- updated docs and readme for beta-3 release

-- updated all in one index page and referneces from docs
-- added initial docs on run.sh
-- linked to teaser video
parent dd270a3c
Loading
Loading
Loading
Loading
+6 −2
Original line number Diff line number Diff line
@@ -2,9 +2,11 @@

Maven Alfresco SDK for Alfresco Development and Customizations based on Apache Maven. 

Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects. 
Includes support for rapid and standard development, testing, packaging, versioning and release of your Alfresco integration and extension projects. For a teaser of the SDK potential check out this video:

It is composed of:
[![Alfresco SDK 2.x teaser](http://img.youtube.com/vi/vgbY9i4w0YU/0.jpg)](https://www.youtube.com/watch?v=vgbY9i4w0YU)

The SDK is composed of:

- An [SDK Parent POM](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/poms/alfresco-sdk-parent/index.html) which you can use in your projects to enable rapid Alfresco development features
- An [Alfresco Platform Distribution POM](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-platform-distribution/latest/index.html) which pre-configures versions of Alfresco and common 3rd party dependency libraries, for stability purposes
@@ -48,6 +50,8 @@ This project is released under the [Apache License, Version 2.0](http://www.apac

## News

- 2014-09-09: SDK 2.0.0-beta-3 released to Maven Central
- 2014-08-30: SDK 2.0.0-beta-1 and 2.0.0-beta-2 available in [Maven Central](http://search.maven.org/#search|ga|1|org.alfresco.maven)
- 2014-08-22: First SNAPSHOT of SDK 2.0.0 in the [OSS Sonatype Repository](https://oss.sonatype.org/content/repositories/snapshots/org/alfresco/maven/alfresco-sdk-parent/2.0.0-SNAPSHOT/)!
- 2014-07: Project fully migrated from [Google Code](https://code.google.com/p/maven-alfresco-archetypes), including tags, branches, issues. Allow a little time for a full cleanup of issue labels and to sort repository permissions. Please update obsolete references and bear with us as we update Alfresco Documentation to this change.
+4 −3
Original line number Diff line number Diff line
<html>
	<head>
		<title>Alfresco SDK 2.x - Running Alfresco ${alfresco.version}</title>
		<title>Alfresco SDK @@alfresco.sdk.parent.version@@ - Running Alfresco ${alfresco.version}</title>
	</head>
	<body style="font: 13px/1.231 Open Sans,arial,helvetica,clean,sans-serif;">
		<img alt="Maven Alfresco SDK" src="https://github.com/Alfresco/alfresco-sdk/raw/master/src/site/resources/img/alfresco-maven-logo.jpg">
		<p>Welcome to the <a href="https://github.com/Alfresco/alfresco-sdk/">Alfresco SDK</a> powered by Apache Maven! You can access the Alfresco components running embedded below:</p>
		<p>Congratulations, you are successfully running the <a href="https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/archetypes/alfresco-allinone-archetype/index.html">All in One project from the <a href="https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-sdk-aggregator/latest/index.html">Alfresco SDK @@alfresco.sdk.parent.version@@</a>, powered by <a href="http://maven.apache.org/">Apache Maven</a>!
		<br/>
		You can access the Alfresco components running embedded below:</p>
		<ul>
			<li><a href="/share">Alfresco Share</a></li>
			<li><a href="/alfresco">Alfresco Repository</a></li>
@@ -18,6 +20,5 @@
			<li><a href="https://issues.alfresco.com/jira/browse/ALF">Report an Alfresco issue</a></li>
			<li><a href="https://github.com/Alfresco/alfresco-sdk/issues/new">Report an SDK issue</a></li>
		</ul>
		
	</body>
</html>
 No newline at end of file
+4 −4
Original line number Diff line number Diff line
  ------
  Maven Alfresco All-in-One Archetype Advanced Usage
  Alfresco All-in-One Archetype Advanced Usage
  ------
  Gabriele Columbro
  ------
  Nov 2012
  Aug 2014
  ------


@@ -15,9 +15,9 @@ All-in-One Archetype properties
    
    * direclty in *.properties, particularly
    
        * For Alfresco WAR projects
        * For the <<<repo>>> project
        
            * <<<src/main/properties/<env>/alfresco-global.properties>>> (environment dependent <<<alfresco-global.properties>>> packaged in the WAR )
            * <<<src/main/properties/<env>/alfresco-global.properties>>> (environment dependent <<<alfresco-global.properties>>> packaged in the WAR when running directly within the AMP project)
        
        * For Alfresco/Share AMP projects
        
+19 −4
Original line number Diff line number Diff line
@@ -22,14 +22,22 @@ Introduction
  
  * Embedded run in Tomcat and embedded H2 database of the full Alfresco suite, including Repository, Share, Solr
  
  * Support for unit and integration testings
  * Support for unit and integration testing and rapid development (using spring-loaded, see run.sh)
  
  * Seamless IDE integration with Eclipse and Idea

How to create a project:

  You can create the latest release archetype with the following command:
  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
+---+
  
  For previous versions, you need to use the Alfresco Artifacts repository:
  
+---+
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:
mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog=https://artifacts.alfresco.com/nexus/content/groups/public/archetype-catalog.xml
+---+
  
  You should then:
@@ -42,7 +50,14 @@ mvn archetype:generate -Dfilter=org.alfresco.maven.archetype:
  
 You can find new Alfresco All-in-One project ready to go in the <<<artifactId>>> folder.

Quickstart

   Once your project is created, enter the project folder and run <<<./run.sh>>> (you might need to <<<chmod u+x run.sh>>> to make it executable. Wait for the startup of the webapps and then go <<<http://localhost:8080>>>.
   This will start Alfresco, Share and Solr. You can import the projects in your favorite IDE (with Maven integration) and start
   developing right away.
   
Usage

  Instructions on how to use the Alfresco All in One archetype can be found on the {{{./usage.html}usage page}}, while 
  
  Full instructions on how to use the Alfresco All in One archetype can be found on the {{{./usage.html}usage page}}, while 
  for more advanced use cases refer to the {{{./advanced-usage.html}advanced usage page}}
+10 −7
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
  ------
  Gabriele Columbro
  ------
  Nov 2012
  Sep 2013
  ------

Prerequisites
@@ -16,8 +16,9 @@ Project layout

+---+
    pom.xml
    |-> amp
    |-> alfresco
    |-> repo-amp
    |-> repo
    |-> share-amp
    |-> share
    |-> solr
    |-> runner (a Tomcat embedded runner / integration test runner)
@@ -48,7 +49,7 @@ Usage
        
        * AMP/WAR packaging
        
        * AMP Unit testing
        * AMP Unit testing and rapid development
        
        * run embedded in Tomcat + H2 database. 
          (<<NOTE>>: this is not a {{{http://www.alfresco.com/services/subscription/supported-platforms/} supported stack}} so use <<only for development purposes>>)
@@ -65,9 +66,11 @@ Usage

Commands

* Commands from the root aggregator project
* Commands from the root aggregator project:

    Common Alfresco project lifecycle commands you want to run from the aggregator :
	* <<<run.sh>>> will automatically set up the SDK and run embedded to enable rapid development

* Additional Common Maven lifecycle commands you want to run from the aggregator are:

    * <<<mvn package>>>: Runs unit tests and packages all customized modules in their respective <<<$\{project.build.directory\}/$\{project.build.finalName\}.amp>>>

@@ -81,4 +84,4 @@ Commands

* Commands from from the <<<runner>>> project

    * <<<mvn jetty:run -Prun'>>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps
    * <<<mvn install -Prun'>>> or <<<'mvn integration-test -Prun'>>> to quickly run already packaged webapps
Loading