Commit 27dd99b8 authored by mindthegab's avatar mindthegab
Browse files

-- minor docs fixes

parent 2d6eec00

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

+7 −3
Original line number Diff line number Diff line
@@ -52,9 +52,13 @@ mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog 


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.

   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). This will setup the SDK and start Alfresco, Share and Solr in embedded mode.  

    

   * Wait for the startup of the webapps and then go <<<http://localhost:8080>>>.

  

   * Import the projects in your favorite IDE (with Maven integration) and start developing right away.

   

Usage

archetypes/alfresco-allinone-archetype/src/site/apt/usage.apt.vm

+2 −4
Original line number Diff line number Diff line
@@ -66,11 +66,9 @@ Usage 


Commands



* Commands from the root aggregator project:

    <<<run.sh>>> will automatically set up the SDK and run the webapps embedded to enable rapid development



	* <<<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:

    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>>>

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

+14 −2
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
  ------

  Gabriele Columbro

  ------

  Spt 2014

  Sept 2014

  ------



Introduction
@@ -55,7 +55,19 @@ mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog 
  

 You can find new Alfresco AMP 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). 

     This will setup the SDK and the Alfresco repository (not Share or Solr).  

    

   * Wait for the startup of the webapp and then go <<<http://localhost:8080/alfresco0>>>.

  

   * Import the project in your favorite IDE (with Maven integration) and start developing right away.

   



Usage



  Instructions on how to use the Alfresco AMP archetype can be found on the {{{./usage.html}usage page}}, while 

  Full instructions on how to use the Alfresco AMP 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}}

archetypes/alfresco-amp-archetype/src/site/apt/usage.apt.vm

+6 −3
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
  ------

  Gabriele Columbro

  ------

  Nov 2012

  Sept 2014

  ------
@@ -27,6 +27,7 @@ Project layout 
            |-> licenses/

  src/main/java //Java classes to be packaged in the AMP embedded JAR)

  src/main/resources //resources to the packaged in the AMP embedded JAR

  src/main/resources/META-INF/resources //web resources to the packaged in the AMP embedded JAR, mapped to the root of the webapp as of Servlet 3.0)

  src/test/java // Unit tests

  src/test/resources // Unit test resources

  src/test/properties/<env> //  Environment aware alfresco-global.properties. By default <env>=local
@@ -55,7 +56,9 @@ Usage 


Commands

    

    Common AMP project lifecycle commands you want to run are:

    <<<run.sh>>> will automatically set up the SDK and run the AMP on an Alfresco repo embedded to enable rapid development



    Also, common AMP Maven lifecycle commands you want to run are:



    * <<<mvn package>>>: Runs unit tests and packages AMP in <<<$\{project.build.directory\}/$\{project.build.finalName\}.amp>>>
@@ -63,7 +66,7 @@ Commands 
    

    * <<<mvn install -Dmaven.test.skip=true>>>: Like <<<mvn install>>> but skips unit tests

    

    * <<<mvn install -Pamp-to-war>>> Like <<<mvn package -Pamp-to-war>>> 

    * <<<mvn install -Pamp-to-war>>>: Like <<<mvn package -Pamp-to-war>>> 

    but also installs and runs the resulting WAR+AMP in Tomcat + H2 embedded from running and development.

    This also enables rapid application development features, like hot reloading and remote JUnit running.

    When you run this command then you can access in your browser <<< {{{http://localhost:8080/alfresco}}} >>>.

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

+13 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
  ------

  Gabriele Columbro

  ------

  Nov 2012

  Sept 2014

  ------



Introduction
@@ -50,6 +50,18 @@ mvn archetype:generate -Dfilter=org.alfresco.maven.archetype: -DarchetypeCatalog 
  

 You can find new Share AMP 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). 

     This will setup the SDK and the Alfresco Share on port 8081 (not Alfresco Repository or Solr).  

    

   * Wait for the startup of the webapp and then go <<<http://localhost:8081/share>>>. <NOTE>: For this to work you need

   to have an Alfresco previously running on port 8080, for example as provided by the {{{../alfresco-amp-archetype/index.html}Alfresco AMP archetype}}

  

   * Import the project in your favorite IDE (with Maven integration) and start developing right away.



Usage



  Instructions on how to use the Share AMP archetype can be found on the {{{./usage.html}usage page}}, while