chore(core): add comments for flextype/config/settings.yaml #186

flextype/config/settings.yaml

@@ -1,15 +1,49 @@
+# The title of the website
 title: Flextype
+
+# The description of the website
 description: Build fast, flexible, easier to manage websites with Flextype.
+
+# The keywords of the website
 keywords: flextype, php, cms, flat-file cms, flat cms, flatfile cms, html
+
+# The robots of the website
 robots: index, follow
+
+# The name and email address of the website author
 author:
   email: ''
   name: ''
+
+# Set the timezone to be used on the website.
+# For a list of valid timezone settings, see:
+# http://php.net/manual/en/timezones.php
 timezone: UTC
+
+# Charset
+#
+# Set internal character encoding.
+#
+# Currently the following names are supported:
+# http://php.net/manual/ru/function.mb-regex-encoding.php#121645
 charset: UTF-8
+
+# Valid date format
+# see: http://php.net/manual/ru/function.date.php
 date_format: F d Y H:i:s
+
+# The theme to use.
+#
+# Don't edit the provided theme templates directly, because they get updated
+# in next releases. If you wish to modify a default theme, copy its folder, and
+# change the name here accordingly.
 theme: default
+
+# The locale that'll be used by the Flextype.
 locale: en_US
+
+# The entries settings
+# Define the file types (extensions to be exact) that are acceptable for upload.
 entries:
   main: home
   media:
@@ -24,8 +58,44 @@ entries:
     description: We're sorry but the page you are looking for doesn't appear to exist!
     content: We're sorry but the page you are looking for doesn't appear to exist!
     template: default
+
+# Display errors
+#
+# - display: Display errors or not.
 errors:
   display: false
+
+# Cache
+#
+# - enabled:         Set to true to enable caching
+#
+# - prefix:          Cache prefix string (prevents cache conflicts)
+#
+# - driver:          Available drivers: auto (will get one from installed cache drivers), apcu,
+#                    apc, array, wincache, xcache, memcache, memcached, redis, file.
+#
+# - lifetime:        Lifetime of cached data in seconds
+#
+# - redis.socket:    Path to redis unix socket (e.g. /var/run/redis/redis.sock),
+#                    false = use server and port to connect
+#
+# - redis.password   Redis password
+#
+# - redis.server     Redis server
+#
+# - redis.port       Redis port
+#
+# - memcache.server  Memcache server
+#
+# - memcache.port    Memcache port
+#
+# - memcached.server Memcached server
+#
+# - memcached.port   Memcached port
+#
+# - sqlite3.database SQLite3 Database
+#
+# - sqlite3.table    SQLite3 Table
 cache:
   enabled: false
   prefix: flextype
@@ -45,8 +115,13 @@ cache:
   sqlite3:
     database: flextype
     table: flextype
+
+# Admin Panel
+#
+# - themes:  Theme (dark, light)
 admin_panel:
   theme: light
+
 whoops:
   editor: atom
   page_title: Error!