Merge branch 'master' of github.com:coralproject/talk into new-queue

docs/README.md

@@ -1,9 +0,0 @@
-# Coral Talk Documentation
-
-To preview the documentation, run:
-
-```bash
-docker run --rm --volume=$PWD:/srv/jekyll -p 127.0.0.1:4000:4000 -it jekyll/jekyll:pages jekyll serve
-```
-
-From the `docs` directory. Then visit: [http://127.0.0.1:4000/talk/](http://127.0.0.1:4000/talk/).

docs/_data/navigation.yml

@@ -34,6 +34,8 @@ docs:
         url: /docs/running/configuration/
       - title: "Secrets"
         url: /docs/running/secrets/
+      - title: "Plugins"
+        url: /docs/running/plugins/
       - title: "Database Migrations"
         url: /docs/running/migrations/
   - title: "Architecture"

docs/_docs/00-01-faq.md

@@ -58,10 +58,10 @@ Fork the Talk repo, clone it locally (no need to go through the install from sou
 
 ```
 cd docs
-docker build --no-cache -t mydocs .
-docker run -v "$PWD:/src" -p 4000:4000 mydocs serve -H 0.0.0.0
+docker run --rm --volume=$PWD:/srv/jekyll -p 127.0.0.1:4000:4000 -it jekyll/jekyll:pages jekyll serve
 ```
 
-You can edit the files in docs with any editor and view the live updates in a browser by hitting `http://localhost:4000`.
+You can edit the files in docs with any editor and view the live updates in a browser by hitting From the docs directory. 
+Then visit: [http://127.0.0.1:4000/talk/](http://127.0.0.1:4000/talk/).
 
 Once you've made the changes, file a PR back to the `coralproject/talk` repo.

docs/_docs/01-01-install.md

@@ -18,4 +18,4 @@ While Talk can be installed in many ways, we support two install paths:
 * [Install via Docker](docker) (deployment)
 
 If you have success installing Talk in another way, please consider
-[contributing to this documentation](faq#how-do-i-contribute-to-these-docs)!
+[contributing to this documentation]({{ "/docs/faq/" | absolute_url }}#how-do-i-contribute-to-these-docs)!

docs/_docs/02-01-configuration.md

@@ -59,6 +59,10 @@ These are only used during the webpack build.
   send keep alive messages through the websocket to keep the socket alive. (Default `30s`)
 - `TALK_INSTALL_LOCK` (_optional for dynamic setup_) - When `TRUE`, disables the dynamic setup endpoint. (Default `FALSE`)
 
+### Word Filter
+
+- `TALK_DISABLE_AUTOFLAG_SUSPECT_WORDS` (_optional_)  When `TRUE`, disables flagging of comments that match the suspect word filter. (Default `FALSE`)
+
 ### JWT
 
 The following are configuration shared with every type of secret used.
@@ -125,6 +129,4 @@ The default could be read as:
 
 ### Plugins
 
-- `TALK_PLUGINS_JSON` (_optional_) - used to specify the plugin config via the
-  environment.
-- `TALK_DISABLE_AUTOFLAG_SUSPECT_WORDS` (_optional_)  When `TRUE`, disables flagging of comments that match the suspect word filter. (Default `FALSE`)
+Plugins configuration can be found on the [Plugins]({{ "/docs/running/plugins/" | absolute_url }}) page.

docs/_docs/02-03-plugins.md

@@ -0,0 +1,25 @@
+---
+title: Plugins
+permalink: /docs/running/plugins/
+---
+
+Configuration for the available plugins are stored in a JSON encoded string. The format
+of this document are available with the [Plugins Overview]({{ "/docs/plugins/" | absolute_url }}).
+
+You can override the plugin config by specifying the content in the `TALK_PLUGIN_JSON`
+environment variable.
+
+## Bundled Plugin Configuration
+{:.no_toc}
+
+Some of the core plugins that are bundled with Talk require specific configuration to be
+available.
+
+{% include toc %} 
+
+### Facebook Authentication
+
+- `TALK_FACEBOOK_APP_ID` (*required*) - the Facebook app id for your Facebook
+Login enabled app.
+- `TALK_FACEBOOK_APP_SECRET` (*required*) - the Facebook app secret for your
+Facebook Login enabled app.

docs/_docs/04-01-plugins.md

@@ -5,7 +5,7 @@ permalink: /docs/plugins/
 
 ## Recipes
 
-Recipes are plugin templates provided by the Coral Core team. Developers can use these recipes to build their own plugins. You can find all the Talk recipes here: https://github.com/coralproject/talk-recipes/
+Recipes are plugin templates provided by the Coral Core team. Developers can use these recipes to build their own plugins. You can find all the Talk recipes here: [https://github.com/coralproject/talk-recipes/](https://github.com/coralproject/talk-recipes/).
 
 ## Plugin Registration
 

plugins/talk-plugin-facebook-auth/README.md

@@ -1,24 +0,0 @@
-# talk-plugin-facebook-auth
-
-This plugin provides facebook authentication support for Talk.
-
-## Configuration
-
-This plugin looks for the following configuration from the environment:
-
-- `TALK_FACEBOOK_APP_ID` (*required*) - the Facebook app id for your Facebook
-Login enabled app.
-- `TALK_FACEBOOK_APP_SECRET` (*required*) - the Facebook app secret for your
-Facebook Login enabled app.
-
-### License
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-        http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-
-    See the License for the specific language governing permissions and limitations under the License.