This is an automated email from the ASF dual-hosted git repository.
dklco pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-app-cms.git
The following commit(s) were added to refs/heads/master by this push:
new 54c89a6 Update intro.md
54c89a6 is described below
commit 54c89a6fcc2cfff9093f1aeead687b8c1db15625
Author: Dan Klco <[email protected]>
AuthorDate: Wed Oct 3 16:52:46 2018 -0400
Update intro.md
---
docs/intro.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/docs/intro.md b/docs/intro.md
index 99b84c9..d985ff8 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -16,13 +16,26 @@ This page will give you an introduction of the structure of
the Sling CMS projec
## Project Structure
-The Sling CMS project has three main modules:
+The Sling CMS project has five main modules:
- builder - this is a Sling Starer builder, it contains the repoinit text
files which define the dependencies and requirements to build Sling CMS. This
will ultimately build the Sling CMS Jar.
+ - api - this is your API for interacting with Sling CMS
- core - this is the Java code behind Sling CMS. This includes the Sling
Models, Filters, Servlets, Post Operations and Rewriter code.
- reference - this is a reference application for developers to use to extend
Sling CMS, this includes both Java code and content loaded by the Sling Content
Loader
- ui - this is a bulk of the content and scripts for the Sling CMS. Most of
this is located under */libs/sling-cms* although there are some other
directories for configurations
+## Using the API
+
+The API can be imported into your Maven project with the following dependency
include in your pom.xml in the `dependencies` element:
+
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.cms.api</artifactId>
+ <version>CURRENT_VERSION</version>
+ <scope>provided</scope>
+ </dependency>
+
+
## Front End Code
Sling CMS uses Gulp to build the front end code which is them packaged by
Maven into the overall project build. This can be a bit chatty over the network
if you run `mvn clean install` with every build, so unless you are updating the
front end code, it's often better to just run `mvn install`
@@ -33,4 +46,4 @@ Most of the scripts are installed under the directory
*/libs/sling-cms/component
## CMS Content
-The Sling CMS uses Sling Resource Merge to allow developers to overlay content
provided in the base CMS. THis means that although the default content is
stored in */libs/sling-cms/content* it is actually used from
*/mnt/overlay/sling-cms/content* a default Resource Rsolver Factory
configuration them maps this path to */cms* for shorter URLs.
\ No newline at end of file
+The Sling CMS uses Sling Resource Merge to allow developers to overlay content
provided in the base CMS. THis means that although the default content is
stored in */libs/sling-cms/content* it is actually used from
*/mnt/overlay/sling-cms/content* a default Resource Rsolver Factory
configuration them maps this path to */cms* for shorter URLs.
