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 2018/11/10 19:45:35 UTC
[sling-org-apache-sling-app-cms] branch master updated (1b9993f ->
e04acf2)
This is an automated email from the ASF dual-hosted git repository.
dklco pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-app-cms.git.
from 1b9993f Updating the readability configuration to be in the correct naming convention to fix SLING-8089
new 85d765c Fixing spelling error
new e04acf2 Adding documentation on content insights
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/content-insights.md | 58 +++++++++++++++++++++++++
docs/img/configure-readability-grade-range.jpg | Bin 0 -> 30160 bytes
docs/img/configure-readability-service.jpg | Bin 0 -> 52586 bytes
docs/img/insights-modal.jpg | Bin 0 -> 38449 bytes
docs/mongodb.md | 2 +-
docs/users.md | 1 +
6 files changed, 60 insertions(+), 1 deletion(-)
create mode 100644 docs/content-insights.md
create mode 100644 docs/img/configure-readability-grade-range.jpg
create mode 100644 docs/img/configure-readability-service.jpg
create mode 100644 docs/img/insights-modal.jpg
[sling-org-apache-sling-app-cms] 01/02: Fixing spelling error
Posted by dk...@apache.org.
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
commit 85d765c066fdadee30594caac4c674b11003f6a9
Author: Dan Klco <dk...@apache.org>
AuthorDate: Sat Nov 10 14:29:42 2018 -0500
Fixing spelling error
---
docs/mongodb.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/mongodb.md b/docs/mongodb.md
index e0d76bc..c2e0b25 100644
--- a/docs/mongodb.md
+++ b/docs/mongodb.md
@@ -14,7 +14,7 @@
By default, Sling CMS stores it's content in a local Tar-backed Apache Oak repository.
-When you setup your Sling CMS instance, you can configure Sling CMS to use a local MongoDB instance by adding the following paramter to the start script:
+When you setup your Sling CMS instance, you can configure Sling CMS to use a local MongoDB instance by adding the following parameter to the start script:
-Dsling.run.modes=oak_mongo
[sling-org-apache-sling-app-cms] 02/02: Adding documentation on
content insights
Posted by dk...@apache.org.
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
commit e04acf24f1483dae8be7f70b6c4b2316bb62bb6d
Author: Dan Klco <dk...@apache.org>
AuthorDate: Sat Nov 10 14:45:29 2018 -0500
Adding documentation on content insights
---
docs/content-insights.md | 58 +++++++++++++++++++++++++
docs/img/configure-readability-grade-range.jpg | Bin 0 -> 30160 bytes
docs/img/configure-readability-service.jpg | Bin 0 -> 52586 bytes
docs/img/insights-modal.jpg | Bin 0 -> 38449 bytes
docs/users.md | 1 +
5 files changed, 59 insertions(+)
diff --git a/docs/content-insights.md b/docs/content-insights.md
new file mode 100644
index 0000000..121e26b
--- /dev/null
+++ b/docs/content-insights.md
@@ -0,0 +1,58 @@
+<!-- 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) > [Users](users.md) > Insights
+
+# Content Insights
+
+Content insights give you insights on the content in Sling CMS. Currently, three insight providers are included in Sling CMS and you can [create custom insight providers](insight-developers.md).
+
+
+
+## HTML Validator
+
+This insight uses the W3C HTML validator to validate the markup of your page and report any markup issues. It requires no configuration and can be run on any page.
+
+## Page Speed
+
+This insight uses Google Page Speed to analyize the page speed performance of a live page, so it will only work on published pages.
+
+### Configuring the Page Speed Insight
+
+To use this insight, you must configure your Google API key at: http://[slingcms]/system/console/configMgr/org.apache.sling.cms.core.insights.impl.providers.PageSpeedInsightProvider
+
+## Readability
+
+This insight will calculate the readability of text, displaying a score based on whether or not a page's text falls within an expected readability grade boundary.
+
+### Configuring the Readability Insight
+
+This insight does require some configuration. At minimum, you must configure the readability grade level bounds. To do this:
+
+ 1. Navigate to your site's configuration root (e.g. http://localhost:8080/cms/config/list.html/conf/[sitename]
+ 2. Create or open the folder `insights`
+ 3. Click the _+ Config_ button to create a new configuration
+ 4. Select the option "Sling CMS - Readability Configuration" and set the title to "Readability"
+ 5. Configure the Min Grade Level and Max Grade Level
+
+ 
+
+ You should now be able to use the Readability insight
+
+ ### Adding Additional Languages
+
+ Sling CMS provides a configuration for the Readability Insight for English. If you are authoring in another language, you can provide a configuration for your language.
+
+ 1. Open the OSGi Configuration Console: http://localhost:8080/system/console/configMgr
+ 2. Find the "Apache Sling CMS - Insights Readability Service" and add a new configuration
+ 3. Set the language and provide the relevant configuration values
+
+ 
+
\ No newline at end of file
diff --git a/docs/img/configure-readability-grade-range.jpg b/docs/img/configure-readability-grade-range.jpg
new file mode 100644
index 0000000..cc7414f
Binary files /dev/null and b/docs/img/configure-readability-grade-range.jpg differ
diff --git a/docs/img/configure-readability-service.jpg b/docs/img/configure-readability-service.jpg
new file mode 100644
index 0000000..6b384de
Binary files /dev/null and b/docs/img/configure-readability-service.jpg differ
diff --git a/docs/img/insights-modal.jpg b/docs/img/insights-modal.jpg
new file mode 100644
index 0000000..bd8671a
Binary files /dev/null and b/docs/img/insights-modal.jpg differ
diff --git a/docs/users.md b/docs/users.md
index f850812..a445b5e 100644
--- a/docs/users.md
+++ b/docs/users.md
@@ -12,6 +12,7 @@
# Users
+* [Content Insights](content-insights.md)
* [Editing a Page](page-editing.md)
* [Managing Content](managing-content.md)
* [Managing Taxonomy](managing-taxonomy.md)
\ No newline at end of file