CampaignChain/campaignchain#192 Subsume all app-wide parameters under…

… campaignchain_core using tree builder
CampaignChain · Jul 16, 2016 · 3b4db3d · 3b4db3d
1 parent adf5b2b
commit 3b4db3d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/open/administrator/configuration/index.rst b/open/administrator/configuration/index.rst
@@ -4,5 +4,6 @@ Configuration
 .. toctree::
     :maxdepth: 2
 
+    overview
     cta
-    oauth_apps.rst
+    oauth_apps
diff --git a/open/administrator/configuration/overview.rst b/open/administrator/configuration/overview.rst
@@ -0,0 +1,26 @@
+Overview
+========
+
+CampaignChain knows two types of configuration options:
+
+* App-wide parameters
+* Bundle-specific parameters
+
+App-wide Parameters
+-------------------
+
+Parameters that configure the app-wide framework are prefixed with
+``campaignchain.`` and defined in two files:
+
+* ``app/config/parameters.yml`` contains the parameters that should be
+  considered during installation.
+* In ``app/config/config_campaignchain.yml``, you will find other app-wide
+  parameters, which contain default values that should be fine for most
+  installations of CampaignChain.
+
+Bundle-specific Parameters
+--------------------------
+
+Each bundle or module might define its own configuration options. These are all
+listed in *app/config/config_campaignchain_bundles.yml* under an alias for each
+bundle, e.g. ``campaignchain_core``.