You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by dk...@apache.org on 2021/09/09 04:09:52 UTC
[sling-org-apache-sling-app-cms] branch master updated: Updating
documentation
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 9fffe29 Updating documentation
9fffe29 is described below
commit 9fffe294f34bdc3b211c79b1dbccfc2ccfcf4e16
Author: Dan Klco <kl...@adobe.com>
AuthorDate: Thu Sep 9 00:09:21 2021 -0400
Updating documentation
---
docs/administration.md | 1 +
docs/deployment-models.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++
docs/project-archetype.md | 2 +-
docs/reference.md | 16 ++++++++++++-
4 files changed, 76 insertions(+), 2 deletions(-)
diff --git a/docs/administration.md b/docs/administration.md
index b99a234..101b986 100644
--- a/docs/administration.md
+++ b/docs/administration.md
@@ -17,6 +17,7 @@
- [Component Policies](component-policy.md)
- [Configuring a Site](configure-site.md)
- [Configuring File Editor](configure-file-editor.md)
+ - [Deployment Models](deployment-models.md)
- [Email Configuration](email-configuration.md)
- [Error Pages](error-pages.md)
- [Image Transformations](image-transformations.md)
diff --git a/docs/deployment-models.md b/docs/deployment-models.md
new file mode 100644
index 0000000..2e80bc3
--- /dev/null
+++ b/docs/deployment-models.md
@@ -0,0 +1,59 @@
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor
+ license agreements. See the NOTICE file distributed with this work for additional
+ information regarding copyright ownership. The ASF licenses this file to
+ you under the Apache License, Version 2.0 (the "License"); you may not use
+ this file except in compliance with the License. You may obtain a copy of
+ the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
+ by applicable law or agreed to in writing, software distributed under the
+ License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
+ OF ANY KIND, either express or implied. See the License for the specific
+ language governing permissions and limitations under the License. -->
+[Apache Sling](https://sling.apache.org) > [Sling CMS](https://github.com/apache/sling-org-apache-sling-app-cms) > [Administration](administration.md) > Deployment Models
+
+# Deployment Models
+
+Apache Sling CMS provides a number of deployment models for your solution needs.
+
+## Instance Types
+
+The project creates a numer of existing models for different instance types.
+
+### Standalone
+
+An instance that is not part of a cluster of instances. In a standalone instance, the instance handled both authoring and rendering web content. Publishing content in a standalone instance is done by updating the `sling:published` property.
+
+Standalone instances are published with the following feature:
+
+ org.apache.sling:org.apache.sling.cms.feature:slingosgifeature:slingcms-standalone:[VERSION]
+
+### Author
+
+An author instance is used to author the content of the site. It is not responsible for rendering the content. Content is published from the author instance to the rendering instance using Sling Content Distribution.
+
+Author instances are published with the following feature:
+
+ org.apache.sling:org.apache.sling.cms.feature:slingosgifeature:slingcms-author:[VERSION]
+
+### Renderer
+
+A renderer instance is used to render the content of the site. It is not responsible for rendering the content. Content should not be authored in the renderer and instead should be published from the author instance to the rendering instance using Sling Content Distribution.
+
+Renderer instances are published with the following feature:
+
+ org.apache.sling:org.apache.sling.cms.feature:slingosgifeature:slingcms-renderer:[VERSION]
+
+## Sample Deployments
+
+There are a number of samples to help you understand how to deploy Sling CMS:
+
+### VM Installation
+
+The [vagrant](../vagrant) directory contains a project to start Sling CMS in [standalone](#Standalone) mode in two CentOS 7 VMs one to run the CMS instance and one to run Apache Web Server.
+
+### Docker Compose
+
+The [docker](../docker) directory contains a project to start Sling CMS with an author-renderer pair with a separate container running Apache Web Server.
+
+### Docker End to End Build
+
+The [klcodanr/com.danklco.sample.infra](https://github.com/klcodanr/com.danklco.sample.infra) project contains a project to build a standalone composite node store Sling CMS instance.
\ No newline at end of file
diff --git a/docs/project-archetype.md b/docs/project-archetype.md
index 6d13074..aa30588 100644
--- a/docs/project-archetype.md
+++ b/docs/project-archetype.md
@@ -20,7 +20,7 @@ To create a project with the archetype, run the following command:
mvn archetype:generate -DarchetypeGroupId=org.apache.sling \
-DarchetypeArtifactId=org.apache.sling.cms.archetype \
- -DarchetypeVersion=0.14.0
+ -DarchetypeVersion=[RELEASE_VERSION]
You should then enter the following values:
diff --git a/docs/reference.md b/docs/reference.md
index e777973..c576634 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -39,6 +39,7 @@ In addition to these reference components, there are two general use components
- container - a container into which other components can be added. This is the most foundational component in Sling CMS allowing for component-driven content development
- rte - a HTML based rich text editor using [wysihtml](http://wysihtml.com/) as the RTE
+ - textelement - a block level text element which can be run through i18n
## Form Components
@@ -46,6 +47,8 @@ There are a number of components specifically for configuring the form.
**Form Value Provider**
+ - requestparameters - Loads form values from the request parameters
+ - suffixresource - Loads form values from the suffix resource
- userprofile - Loads form field values from the current user's profile subnode
**Form Field**
@@ -54,4 +57,15 @@ There are a number of components specifically for configuring the form.
- honeypot - adds a spam-blocking honeypot to the form, should be hidden from view, any submission with this field filled out will be blocked
- selection - allows for the users to select from options defined in tags, can be rendered as radio, checkboxes or a dropdown
- textfield - basic text field with support for HTML5 types
- - textarea - basic text area
\ No newline at end of file
+ - textarea - basic text area
+
+**Form Actions**
+
+ - createuser - creates a new user based on the form data
+ - deleteugc - deletes user generated content
+ - requestpasswordreset - requests a password reset
+ - resetpassword - resets the password for a user
+ - sendemail - sends an email
+ - updateprofile - updates the user's profile
+ - updateugc - updates user generated content
+ - usergeneratedcontent - creates user generated content
\ No newline at end of file