linkedin/cleo — Issue #2: Quick Start - "main" suggestion
Author: jlpoolen
Created: 2012-03-04 14:10:00+00:00
State: open

At http://sna-projects.com/cleo/quickstart.php there is:

Download cleo-primer from Github.

git clone --depth 1 git@github.com:jingwei/cleo-primer.git cleo-primer

Launch the cleo-primer web application from the main folder.

MAVEN_OPTS="-Xms1g -Xmx1g" mvn jetty:run \
-Dcleo.instance.name=Company \
-Dcleo.instance.type=cleo.primer.GenericTypeaheadInstance \
-Dcleo.instance.conf=src/main/resources/config/generic-typeahead

For someone new to Maven (as I am) who simply wants to evaluate your project's demo and not undertake learning the niceties of Maven, the reference to "main folder" above may cause one to go into the folder "cleo-primer/src/main" and then attempt to run the proffered command there. Doing so, of course, will cause Maven to complain that it cannot find the jetty plugin (see below).

Since you have specified the project folder as "cleo-primer", why not then have the following instruction be in accord and state:

Launch the cleo-primer web application from the folder "cleo-primer".

This will remove any ambiguity about "main" meaning ".../cleo-primer" in the generic sense as you intend or ".../cleo-primer/src/main" and possibly save people posting error messages such as this:

jlpoole@themis /usr/local/src/cleo-primer/src/main $ MAVEN_OPTS="-Xms1g -Xmx1g" mvn jetty:run -Dcleo.instance.name=Company -Dcleo.instance.type=cleo.primer.GenericTypeaheadInstance -Dcleo.instance.conf=src/main/resources/config/generic-typeahead
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'jetty'.
[INFO] org.apache.maven.plugins: checking for updates from central
[INFO] org.codehaus.mojo: checking for updates from central
[INFO] artifact org.apache.maven.plugins:maven-jetty-plugin: checking for updates from central
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] The plugin 'org.apache.maven.plugins:maven-jetty-plugin' does not exist or no valid version could be found
[INFO] ------------------------------------------------------------------------
[INFO] For more information, run Maven with the -e switch
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1 second
[INFO] Finished at: Sun Mar 04 05:07:06 PST 2012
[INFO] Final Memory: 6M/981M
[INFO] ------------------------------------------------------------------------
jlpoole@themis /usr/local/src/cleo-primer/src/main $