Reorganize config documentation

Author: HashNuke

docs/configuration.md

@@ -52,19 +52,19 @@ The domains/subdomains to use for your project. By default your project is acces
 
 ## Optional config
 
-#### mix_env
+##### mix_env
 
 The `MIX_ENV` to use when running the app. Default is `prod`.
 
-#### git_ref
+##### git_ref
 
 Git ref of the project to deploy. This can be a branch (*recommended*) or tag or commit you want to deploy. Defaults to `master` branch.
 
 * Default: `master`
 * Examples: `74e09b4fe3fca`, `stable`, `v3.4.1`
 
 
-#### deploy_type
+##### deploy_type
 
 > **NOTE:** Read the documentation on [Hot code-reloading](hot-code-reloading.md) for whys & hows of this variable.
 
@@ -75,24 +75,33 @@ By default, on each deploy your app will be restarted. Setting it to `upgrade` w
 
 You can switch between restarts and upgrades anytime.
 
-#### deployer
+##### secret_key_base_length
+
+Length of the secret key base. Can be set to any integer.
+
+* Default: `64`
+
+##### deployer
 
 The name of the user to create to run all your projects. Default is `deployer`.
 
-#### projects_dir
+##### projects_dir
 
 The dir where all your projects will be stored. This is relative to the $HOME of the deployer user.
 
 * Default: `projects`
 
-#### setup_postgres
+##### setup_postgres
 
 If you app doesn't require postgres, set this option to `False`.
 
 * Default: `True`
 * Possible values: `True`, `False`
 
-#### build_frontend
+
+### Frontend build configuration
+
+##### build_frontend
 
 If the app does not require building frontends, set this this to `False`.
 
@@ -106,7 +115,7 @@ The directory where the `package.json` file resides. For a Phoenix app by defaul
 * Default: `""` (an empty string)
 
 
-#### frontend_build_command
+##### frontend_build_command
 
 The command to use to build the frontend.
 
@@ -122,63 +131,43 @@ Command that should be run after the frontend build has completed. This is run i
 
 * Default: `mix phoenix.digest`
 
-#### app_alert_emails
-
-List of email addresses to alert if the app goes down. No emails are sent by default.
-
-* Default: `[]`
-* Example values:
-    * `["[email protected]"]`
-    * `["[email protected]", "[email protected]"]`
-
-
-#### nginx_alert_emails
-
-List of email addresses to alert if nginx goes down. No emails are sent by default.
-
-* Default: `[]`
-* Example values:
-    * `["[email protected]"]`
-    * `["[email protected]", "[email protected]"]`
-
-> NOTE: `nginx_alert_emails` is common for the entire server. So if you set it in one app, maintain the same values in all your apps. Please create an issue if you can think of a better solution.
+### Swap file configuration
 
-#### create_swap_file
+##### create_swap_file
 
 Creates a swap if this is set to `True`.
 
 * Default: `True`
 * Possible values: `True`, `False`
 
-#### swap_size
+##### swap_size
 
 If `create_swap_file` is set to `True`, this option can be used to specify the size of the swap to create. by default the size is 2gb. If you aren't sure leave this unchanged.
 
 * Default: `2097K`
 * Possible values: calculated as `1024 * 1024 * n`. So for 4gb that would be 4194304, which can be specified as `4194K`
 
 
-#### npm_config_jobs
+### NPM configuration
+
+##### npm_config_jobs
 
 Set this to more than `1` if npm should be allowed to be run in parallel. For 512mb RAM servers, it's better to set this to `1`.
 
 * Default: `1`
 * Example values: `2`, `5`
 
-#### npm_config_install_production
+##### npm_config_install_production
 
 If set to `True`, npm dependencies will be installed with `npm install --production`. Else it is just `npm install`.
 
 * Default: `False`
 * Possible values: `True`, `False`
 
-#### secret_key_base_length
-
-Length of the secret key base. Can be set to any integer.
 
-* Default: `64`
+### Monitoring email alerts
 
-#### enable_mail_alerts
+##### enable_mail_alerts
 
 Will send mail alerts when stuff goes down. If this is enabled, SMTP configuration needs to be provided.
 
@@ -187,29 +176,51 @@ Will send mail alerts when stuff goes down. If this is enabled, SMTP configurati
 
 You could use GMail, [MailGun](http://mailgun.com), [Amazon SES](http://aws.amazon.com/ses/), [SendGrid](https://sendgrid.com) or anything else. Most providers have a free quota that should be sufficient for your hobby apps.
 
-#### smtp_host
+##### app_alert_emails
+
+List of email addresses to alert if the app goes down. No emails are sent by default.
+
+* Default: `[]`
+* Example values:
+    * `["[email protected]"]`
+    * `["[email protected]", "[email protected]"]`
+
+
+##### nginx_alert_emails
+
+List of email addresses to alert if nginx goes down. No emails are sent by default.
+
+* Default: `[]`
+* Example values:
+    * `["[email protected]"]`
+    * `["[email protected]", "[email protected]"]`
+
+> NOTE: `nginx_alert_emails` is common for the entire server. So if you set it in one app, maintain the same values in all your apps. Please create an issue if you can think of a better solution.
+
+
+##### smtp_host
 
 Set this to your SMTP host.
 
 Example values: `smtp.gmail.com`, `smtp.mailgun.org`
 
-#### smtp_port
+##### smtp_port
 
 Set this to your host's SMTP port. For most servers, the default would work.
 
 * Default: `587`
 
-#### smtp_user
+##### smtp_user
 
 Email address you want to send mails from.
 
 * Example values: `[email protected]`, `[email protected]`
 
-#### smtp_password
+##### smtp_password
 
 Password for the SMTP user account.
 
-#### smtp_use_tls
+##### smtp_use_tls
 
 Does your SMTP host use TLS? As a reference, set this to `True` for GMail & `False` for [MailGun](http://mailgun.com).