Update docs (#362)

* fix editorconfig

* adjust .env.example

* update docs

* update links

* update link

* fix nested blocks

* add links to the slides

* clarify companion description procedure

* remove link to stale job

* clarify comment

* typo

* typo

* update github app section

* explain the requirements

* improve gitlab mention

* reformat

* wording

* clarify

* typo

* expand on deployment environments

* fix switch between production and staging environment

* reorganize

Author: joao-paulo-parity

.editorconfig

@@ -6,6 +6,6 @@ insert_final_newline = true
 indent_style = tab
 trim_trailing_whitespace = true
 
-[*.{yml,yaml}]
+[*.{yml,yaml,md}]
 indent_style = space
 indent_size = 2

.env.example

@@ -1,14 +1,12 @@
-# Move this file to .env in order to have it take effect.
-# All values are only examples. You should figure out if they are proper by the
-# application's code.
+# Set the appropriate values and copy this file to .env
 
 # --- REQUIRED VARIABLES ---
 # The port where the server will be started at
 WEBHOOK_PORT=8080
 
-# The organization name or repository owner username of where the Github App is
-# installed
-INSTALLATION_LOGIN=org
+# The organization name or the repository owner's username of where the Github
+# App is installed
+INSTALLATION_LOGIN=placeholder
 
 # The path of the database directory. If it's not an absolute path, it will be
 # relative to this repository's root.
@@ -23,18 +21,18 @@ REPOSITORIES_PATH=repositories
 PRIVATE_KEY_PATH=githubPrivateKey.pem
 
 # The webhook secret according to the Github App's settings.
-WEBHOOK_SECRET=hunter2
+WEBHOOK_SECRET=placeholder
 
 # The Github App ID according to the Github App's settings.
 GITHUB_APP_ID=123
 
 # The GitHub team which whose members will be used as team leads
-# Must be in the same organization where this bot is installed
-TEAM_LEADS_TEAM=team
+# Must be from the organization where the GitHub App is installed
+TEAM_LEADS_TEAM=placeholder
 
 # The GitHub team which whose members will be used as core developers
-# Must be in the same organization where this bot is installed
-CORE_DEVS_TEAM=team
+# Must be from the organization where the GitHub App is installed
+CORE_DEVS_TEAM=placeholder
 
 
 # --- OPTIONAL VARIABLES ---