#5 Split docs into Open and Custom Edition

CampaignChain · Jul 15, 2016 · 6b86cb2 · 6b86cb2
1 parent b2d5598
commit 6b86cb2
Show file tree

Hide file tree

Showing 32 changed files with 141 additions and 31 deletions.
diff --git a/contributing/index.rst b/contributing/index.rst
diff --git a/custom/index.rst b/custom/index.rst
@@ -0,0 +1,46 @@
+CampaignChain Open Edition
+==========================
+
+Developers
+----------
+
+Get started with CampaignChain quickly in this step-by-step guide.
+
+.. toctree::
+    :maxdepth: 1
+
+    developer/quick_tour/index
+
+Learn the general concepts of developing with CampaignChain.
+
+.. toctree::
+    :maxdepth: 2
+
+    developer/book/index
+
+Hands-on tutorials that teach you how to use CampaignChain in concrete scenarios.
+
+.. toctree::
+    :maxdepth: 2
+
+    developer/cookbook/index
+
+Administrators
+--------------
+
+Documentation that explains how to install and configure CampaignChain.
+
+.. toctree::
+    :maxdepth: 2
+
+    administrator/index
+
+Miscellanea
+-----------
+
+.. toctree::
+    :maxdepth: 2
+
+    contributing/index
+    glossary
+    contributing/documentation/license
diff --git a/glossary.rst → documentation/glossary.rst b/glossary.rst → documentation/glossary.rst
diff --git a/contributing/documentation/index.rst → documentation/index.rst b/contributing/documentation/index.rst → documentation/index.rst
@@ -5,4 +5,5 @@ Contributing to Documentation
     :maxdepth: 1
 
     standards
-    license
+    license
+    glossary
diff --git a/contributing/documentation/license.rst → documentation/license.rst b/contributing/documentation/license.rst → documentation/license.rst
diff --git a/contributing/documentation/standards.rst → documentation/standards.rst b/contributing/documentation/standards.rst → documentation/standards.rst
diff --git a/index.rst b/index.rst
@@ -1,39 +1,55 @@
 CampaignChain Documentation
 ===========================
 
-Developers
-----------
+Abstract
+--------
 
-Get started with CampaignChain quickly in this step-by-step guide.
+This is the CampaignChain documentation. It provides information to end users,
+administrators and developers.
 
-.. toctree::
-    :maxdepth: 1
+What is CampaignChain?
+----------------------
+
+With CampaignChain, marketers can plan, execute, monitor and optimize campaigns
+in a holistic overview. Programmers can integrate communication channels, tools
+and devices with our open-source platform.
 
-    /developer/quick_tour/index
+Today, marketers face an increasing amount of online channels, tools and devices
+(IoT, beacons). As the opportunities for highly targeted marketing grow, so
+does fragmentation of workflows. CampaignChain is the only marketing technology
+that allows for a comprehensive real-time access to all marketing activities.
 
-Learn the general concepts of developing with CampaignChain.
+Our goal is to help everyone make innovative marketing ideas come true.
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
+
+        Introduction for Marketers <user/overview>
+        Introduction for Developers <open/overview>
 
-    /developer/book/index
+CampaignChain Open Edition
+--------------------------
 
-Hands-on tutorials that teach you how to use CampaignChain in concrete scenarios.
+The CampaignChain Open Edition is available under an Open Source license on
+GitHub. It is the first open-source platform for marketing integration.
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
-    /developer/cookbook/index
+    open/index
 
-Administrators
---------------
+CampaignChain Custom Edition
+----------------------------
 
-Documentation that explains how to install and configure CampaignChain.
+The CampaignChain Custom Edition is a commercial product. It is based on the
+CampaignChain Open Edition and provides additional features, such as easy
+deployment for development or production environments, as well as automated
+updates to simplify the maintenance of CampaignChain instances.
 
 .. toctree::
     :maxdepth: 2
 
-    /administrator/index
+    custom/index
 
 Users
 -----
@@ -43,14 +59,14 @@ Tips & tricks for marketers to make the best use of CampaignChain.
 .. toctree::
     :maxdepth: 2
 
-    /user/index
+    user/index
+
+Documentation
+-------------
 
-Miscellanea
------------
+Learn how to contribute to this documentation, about its license, and more.
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
-    /contributing/index
-    glossary
-    contributing/documentation/license
+        documentation/index
diff --git a/administrator/configuration/cta.rst → open/administrator/configuration/cta.rst b/administrator/configuration/cta.rst → open/administrator/configuration/cta.rst
diff --git a/administrator/configuration/index.rst → open/administrator/configuration/index.rst b/administrator/configuration/index.rst → open/administrator/configuration/index.rst
diff --git a/administrator/configuration/oauth_apps.rst → ...dministrator/configuration/oauth_apps.rst b/administrator/configuration/oauth_apps.rst → ...dministrator/configuration/oauth_apps.rst
diff --git a/...ator/include/_configure_scheduler.rst.inc → ...ator/include/_configure_scheduler.rst.inc b/...ator/include/_configure_scheduler.rst.inc → ...ator/include/_configure_scheduler.rst.inc
diff --git a/...r/include/_get_bitly_access_token.rst.inc → ...r/include/_get_bitly_access_token.rst.inc b/...r/include/_get_bitly_access_token.rst.inc → ...r/include/_get_bitly_access_token.rst.inc
diff --git a/administrator/index.rst → open/administrator/index.rst b/administrator/index.rst → open/administrator/index.rst
diff --git a/administrator/installation/ce.rst → open/administrator/installation/ce.rst b/administrator/installation/ce.rst → open/administrator/installation/ce.rst
diff --git a/administrator/installation/dev.rst → open/administrator/installation/dev.rst b/administrator/installation/dev.rst → open/administrator/installation/dev.rst
diff --git a/administrator/installation/index.rst → open/administrator/installation/index.rst b/administrator/installation/index.rst → open/administrator/installation/index.rst
diff --git a/administrator/requirements.rst → open/administrator/requirements.rst b/administrator/requirements.rst → open/administrator/requirements.rst
diff --git a/developer/book/activities_operations.rst → .../developer/book/activities_operations.rst b/developer/book/activities_operations.rst → .../developer/book/activities_operations.rst
diff --git a/developer/book/channels_locations.rst → open/developer/book/channels_locations.rst b/developer/book/channels_locations.rst → open/developer/book/channels_locations.rst
diff --git a/developer/book/cta.rst → open/developer/book/cta.rst b/developer/book/cta.rst → open/developer/book/cta.rst
diff --git a/developer/book/dev_mode.rst → open/developer/book/dev_mode.rst b/developer/book/dev_mode.rst → open/developer/book/dev_mode.rst
diff --git a/developer/book/development_environment.rst → ...eveloper/book/development_environment.rst b/developer/book/development_environment.rst → ...eveloper/book/development_environment.rst
diff --git a/developer/book/index.rst → open/developer/book/index.rst b/developer/book/index.rst → open/developer/book/index.rst
diff --git a/developer/book/modules.rst → open/developer/book/modules.rst b/developer/book/modules.rst → open/developer/book/modules.rst
diff --git a/developer/book/overview.rst → open/developer/book/overview.rst b/developer/book/overview.rst → open/developer/book/overview.rst
diff --git a/developer/book/sample_data.rst → open/developer/book/sample_data.rst b/developer/book/sample_data.rst → open/developer/book/sample_data.rst
diff --git a/...cookbook/connect_a_new_online_channel.rst → ...cookbook/connect_a_new_online_channel.rst b/...cookbook/connect_a_new_online_channel.rst → ...cookbook/connect_a_new_online_channel.rst
diff --git a/open/developer/cookbook/how_to_use_the_rest_api.rst b/open/developer/cookbook/how_to_use_the_rest_api.rst
@@ -0,0 +1,17 @@
+How to Use the REST API
+=======================
+
+This tutorial teaches you how to make use of the built-in REST API available for
+CampaignChain.
+
+Scenario
+--------
+
+#. User navigates to landing page.
+#. Get ongoing and upcoming scheduled campaigns and display to user to select.
+#. Get CC users and display to user to select.
+#. User provides a publishing date (cannot be prior to now).
+#. Ensure that publishing date is within campaign duration.
+#. User saves page.
+#. System retrieves Channel by URL and module URI (should be done in advance and by storing channel ID).
+#. System creates new Activity by providing Channel ID, Activity, assignee and Location data.
diff --git a/developer/cookbook/index.rst → open/developer/cookbook/index.rst b/developer/cookbook/index.rst → open/developer/cookbook/index.rst
@@ -5,3 +5,4 @@ The Developer Cookbook
     :maxdepth: 2
 
     connect_a_new_online_channel
+    how_to_use_the_rest_api
diff --git a/developer/index.rst → open/developer/index.rst b/developer/index.rst → open/developer/index.rst
diff --git a/developer/quick_tour/index.rst → open/developer/quick_tour/index.rst b/developer/quick_tour/index.rst → open/developer/quick_tour/index.rst
diff --git a/open/index.rst b/open/index.rst
@@ -0,0 +1,36 @@
+CampaignChain Open Edition
+==========================
+
+Developers
+----------
+
+Get started with CampaignChain quickly in this step-by-step guide.
+
+.. toctree::
+    :maxdepth: 1
+
+    developer/quick_tour/index
+
+Learn the general concepts of developing with CampaignChain.
+
+.. toctree::
+    :maxdepth: 2
+
+    developer/book/index
+
+Hands-on tutorials that teach you how to use CampaignChain in concrete scenarios.
+
+.. toctree::
+    :maxdepth: 2
+
+    developer/cookbook/index
+
+Administrators
+--------------
+
+Documentation that explains how to install and configure CampaignChain.
+
+.. toctree::
+    :maxdepth: 2
+
+    administrator/index