From c6edbe06cf789ba5060e98766de9a7562f5c86b6 Mon Sep 17 00:00:00 2001
From: Barbara Gomes <barbaramaltagomes@gmail.com>
Date: Sat, 2 Jul 2016 09:02:46 -0700
Subject: [PATCH] [IOTA-19] Improve comments on Default configuration for Fey

https://issues.apache.org/jira/browse/IOTA-19
---
 fey-core/src/main/resources/application.conf | 24 ++++++++++++++++----
 1 file changed, 19 insertions(+), 5 deletions(-)

diff --git a/fey-core/src/main/resources/application.conf b/fey-core/src/main/resources/application.conf
index c96ef5d..28992f4 100644
--- a/fey-core/src/main/resources/application.conf
+++ b/fey-core/src/main/resources/application.conf
@@ -15,6 +15,9 @@
 //limitations under the License.
 //
 
+// Defines the default configuration for Fey
+// User can override this configuration by creating a configuration file
+// with the same schema and passing it as a argument to Fey.
 fey-global-configuration{
 
   // If check point is not enabled Fey won't check out the last state
@@ -25,26 +28,37 @@ fey-global-configuration{
   enable-checkpoint = true
 
   // Directory where fey is going to store its checkpoint
+  // Only the latest running Orchestration JSONs will be saved, no message will be checkpointed.
+  // It will not be used if "enable-checkpoint" is false
   checkpoint-directory = "/tmp/fey/checkpoint"
 
-  // Directory where the JSON will be sitting
+  // Directory that will be watched by Fey in order to get the Orchestration JSON files
+  // This directory must exist on your computer, Fey will not create it in case it does not
+  // and a exception will be thrown by the WatchService actor
   json-repository = ${HOME}"/feyJSONRepo"
 
-  // Defines each file extension to look for inside the JSON Repo
+  // Defines the file extension that will be processed by Fey.
+  // Files that does not have this extension will be ignored.
   json-extension = ".json"
 
-  // Defines the repo for the jars
+  // Directory where Fey will be loading the Performers from.
+  // This directory must exist on your computer, as well as all of the
+  // jars that are being specified in the Orchestration JSON
   jar-repository = ${HOME}"/feyJarRepo"
 
   // Fey Log Level
   log-level = "DEBUG"
 
-  // Defines where the log will be appended
-  // Options: FILE or STDOUT or FILE_STDOUT
+  // Defines where the log will be appended to
+  // Options:
+  // FILE -> Appends log the a rolling file at ~/.fey/logs/fey_core.log
+  // STDOUT -> Appends log to STDOUT
+  // FILE_STDOUT -> Appends log to STDOUT as well as to FILE
   log_appender = "STDOUT"
 
 }
 
+// Fey akka configuration. Can not be overwritten by user
 akka {
   loggers = ["akka.event.slf4j.Slf4jLogger"]
   loglevel = "DEBUG"