[sling-org-apache-sling-app-cms] branch master updated: Adding sonarcloud badges and cleaning up some doc formatting

[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


The following commit(s) were added to refs/heads/master by this push:
     new 56bda25  Adding sonarcloud badges and cleaning up some doc formatting
56bda25 is described below

commit 56bda25a4039f3c92e9ac6ce15eff5ac47c3b69f
Author: Dan Klco <dk...@apache.org>
AuthorDate: Tue Apr 16 08:52:32 2019 -0400

    Adding sonarcloud badges and cleaning up some doc formatting
---
 README.md           |  2 +-
 docs/error-pages.md | 15 ++++++++++-----
 docs/intro.md       |  6 +++---
 docs/reference.md   | 10 +++++-----
 4 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index e0dbe85..86182f9 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 [<img src="https://sling.apache.org/res/logos/sling.png"/>](https://sling.apache.org)
 
- [![Build Status](https://builds.apache.org/buildStatus/icon?job=Sling/sling-org-apache-sling-app-cms/master)](https://builds.apache.org/job/Sling/job/sling-org-apache-sling-app-cms/job/master) [![Test Status](https://img.shields.io/jenkins/t/https/builds.apache.org/job/Sling/job/sling-org-apache-sling-app-cms/job/master.svg)](https://builds.apache.org/job/Sling/job/sling-org-apache-sling-app-cms/job/master/test_results_analyzer/) [![Maven Central](https://maven-badges.herokuapp.com/mave [...]
+ [![Build Status](https://builds.apache.org/buildStatus/icon?job=Sling/sling-org-apache-sling-app-cms/master)](https://builds.apache.org/job/Sling/job/sling-org-apache-sling-app-cms/job/master) [![Test Status](https://img.shields.io/jenkins/t/https/builds.apache.org/job/Sling/job/sling-org-apache-sling-app-cms/job/master.svg)](https://builds.apache.org/job/Sling/job/sling-org-apache-sling-app-cms/job/master/test_results_analyzer/) [![Sonarcloud Status](https://sonarcloud.io/api/project_b [...]
 
 # Apache Sling CMS
 
diff --git a/docs/error-pages.md b/docs/error-pages.md
index 4dfc7c9..c814bd0 100644
--- a/docs/error-pages.md
+++ b/docs/error-pages.md
@@ -44,14 +44,19 @@ Instead, you can configure these pages to be ignored by mod_proxy and served dir
 This takes a few steps:
 
 1. Add the following directive into your mod_proxy configuration:
+    
         ProxyPass /ERROR !
-    This instructs mod_proxy to ignore the directory /ERROR
+    
+This instructs mod_proxy to ignore the directory /ERROR
+    
 2. Add the following directive into your conf file:
+
         # Configure Error Documents if Down
-       ErrorDocument 502 /ERROR/502.html
-       ErrorDocument 503 /ERROR/503.html
-       ErrorDocument 504 /ERROR/504.html
-       Alias /ERROR /var/www/vhosts/site
+        ErrorDocument 502 /ERROR/502.html
+        ErrorDocument 503 /ERROR/503.html
+        ErrorDocument 504 /ERROR/504.html
+        Alias /ERROR /var/www/vhosts/site
+    
 3. Create the relevant pages under /var/www/vhosts/site
 
 The error pages should be static HTML, ideally with all CSS, images, etc inlined. You don't necessarily need to provide separate error pages for each status code.
\ No newline at end of file
diff --git a/docs/intro.md b/docs/intro.md
index d985ff8..d1b072c 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -22,7 +22,7 @@ The Sling CMS project has five main modules:
  - 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
+ - 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
 
@@ -42,8 +42,8 @@ Sling CMS uses Gulp to build the front end code which is them packaged by Maven
 
 ## Important Directories
 
-Most of the scripts are installed under the directory */libs/sling-cms/components* and the contet is under */libs/sling-cms/content* 
+Most of the scripts are installed under the directory `/libs/sling-cms/components` and the content is under `/libs/sling-cms/content`
 
 ## 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.
+The Sling CMS uses [Sling Resource Merger](https://sling.apache.org/documentation/bundles/resource-merger.html) 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 referenced under `/mnt/overlay/sling-cms/content` which is merged with `/apps/sling-cms/content` using Sling Resource Merger, finally a default Resource Resolver Factory configuration them maps this path to `/cms` fo [...]
diff --git a/docs/reference.md b/docs/reference.md
index d7d5491..c16ed9a 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -18,10 +18,10 @@ These components are:
 
  - base page - a basic page using the Apache Sling website styling
  - breadcrumb - breadcrumb based on the page hierarchy
- - cta - a CTA link
+ - cta - a call to action link / button
  - codeblock - displays a block of code in a `<pre>` tag
  - columncontrol - allows authors to create columns of content
- - iframe - allows for adding an iframe				stylewrapper.json
+ - iframe - allows for adding an iframe
  - image - a block level image allowing linked and styled images
  - list	- a base component for creating dynamic lists
  - search - a simple search component using JCR Queries to search page content	
@@ -31,7 +31,7 @@ These components are:
  - rss - renders an RSS feed backed on a query
  - tags - displays the taxonomy tags on a page
  
-In addition to these reference components, there are two general use components in the main ui project. These are found at /libs/sling-cms/components/general and are:
+In addition to these reference components, there are two general use components in the main ui project. These are found at `/libs/sling-cms/components/general` and are:
 
- - container - a container into which other components can be aded. This is the most foundational component in Sling CMS allowing for Component-drive content development.
- - rte - a HTML based rich text editor using Summernote as the RTE
\ No newline at end of file
+ - container - a container into which other components can be aded. 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
\ No newline at end of file