From 12e48efa9f611ee2647d615943c58aff3e758c5b Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Mon, 31 Jul 2017 14:11:40 +1000 Subject: [PATCH] some docs updates --- docs/README.md | 9 ------- docs/_data/navigation.yml | 2 ++ docs/_docs/00-01-faq.md | 6 ++--- docs/_docs/01-01-install.md | 2 +- docs/_docs/02-01-configuration.md | 8 +++--- docs/_docs/02-03-plugins.md | 25 +++++++++++++++++++ ...2-03-migrations.md => 02-04-migrations.md} | 0 docs/_docs/04-01-plugins.md | 2 +- plugins/talk-plugin-facebook-auth/README.md | 24 ------------------ 9 files changed, 37 insertions(+), 41 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/_docs/02-03-plugins.md rename docs/_docs/{02-03-migrations.md => 02-04-migrations.md} (100%) delete mode 100644 plugins/talk-plugin-facebook-auth/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index b5637517d..000000000 --- a/docs/README.md +++ /dev/null @@ -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/). \ No newline at end of file diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 68b4d9803..0a9577e2b 100755 --- a/docs/_data/navigation.yml +++ b/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" diff --git a/docs/_docs/00-01-faq.md b/docs/_docs/00-01-faq.md index c923aa65a..cdaf5dbf3 100644 --- a/docs/_docs/00-01-faq.md +++ b/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. diff --git a/docs/_docs/01-01-install.md b/docs/_docs/01-01-install.md index 1ba511522..055217797 100644 --- a/docs/_docs/01-01-install.md +++ b/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)! diff --git a/docs/_docs/02-01-configuration.md b/docs/_docs/02-01-configuration.md index cb9a51d23..ab644e5e3 100644 --- a/docs/_docs/02-01-configuration.md +++ b/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`) \ No newline at end of file +Plugins configuration can be found on the [Plugins]({{ "/docs/running/plugins/" | absolute_url }}) page. \ No newline at end of file diff --git a/docs/_docs/02-03-plugins.md b/docs/_docs/02-03-plugins.md new file mode 100644 index 000000000..e17f53f9e --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/_docs/02-03-migrations.md b/docs/_docs/02-04-migrations.md similarity index 100% rename from docs/_docs/02-03-migrations.md rename to docs/_docs/02-04-migrations.md diff --git a/docs/_docs/04-01-plugins.md b/docs/_docs/04-01-plugins.md index bfe2c4407..8b9b1c99a 100644 --- a/docs/_docs/04-01-plugins.md +++ b/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 diff --git a/plugins/talk-plugin-facebook-auth/README.md b/plugins/talk-plugin-facebook-auth/README.md deleted file mode 100644 index 6faceed09..000000000 --- a/plugins/talk-plugin-facebook-auth/README.md +++ /dev/null @@ -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.