From f48062e38f2c7cdd3960a2145ead35ff9cfeb034 Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Wed, 7 Mar 2018 17:10:57 -0500 Subject: [PATCH] Add Admin configuration docs --- docs/source/02-05-configuring-admin.md | 54 +++++++++++++++++++++ docs/source/02-05-configuring-moderation.md | 54 +++++++++++++++++++++ 2 files changed, 108 insertions(+) create mode 100644 docs/source/02-05-configuring-admin.md create mode 100644 docs/source/02-05-configuring-moderation.md diff --git a/docs/source/02-05-configuring-admin.md b/docs/source/02-05-configuring-admin.md new file mode 100644 index 000000000..baecc9c10 --- /dev/null +++ b/docs/source/02-05-configuring-admin.md @@ -0,0 +1,54 @@ +--- +title: Configuring the Talk Admin +permalink: /configuring-the-admin/ +class: configuration +toc: true +--- + +Using plugins and configuration variables, you can modify the way the Admin looks and how moderation works. + +### Creating a Custom Moderation Queue + +Talk can support custom pluggable mod queues, meaning you can write a plugin that has some logic and determines which comments should appear there. This works by adding a field modQueues` in the `index.js` of your client side plugin, like so: + +``` + modQueues: { + newQueueKey: { + + // name + name: 'My Queue Name', + + // material design icon + icon: 'star', + + // Filter by tags + tags: ['MY_TAG'], + + // Filter by statuses + statuses: ['NONE', 'PREMOD', 'ACCEPTED', 'REJECTED'], + + // Filter by comment containing action_type + action_type: 'FLAG', + + }, + }, +``` + + +So if we wanted to make a Featured queue, we could do this like so: + +``` + modQueues: { + featured: { + tags: ['FEATURED'], + icon: 'star', + name: 'Featured', + }, + }, +``` + +For more information, see here: https://github.com/coralproject/talk/pull/849 + +### Flag Details + +To show more detailed information about reporting/flags, you can enable `talk-plugin-flag-details`. diff --git a/docs/source/02-05-configuring-moderation.md b/docs/source/02-05-configuring-moderation.md new file mode 100644 index 000000000..134d94209 --- /dev/null +++ b/docs/source/02-05-configuring-moderation.md @@ -0,0 +1,54 @@ +--- +title: Configuring the Talk Admin +permalink: /configuring-the-admin// +class: configuration +toc: true +--- + +Using plugins and configuration variables, you can modify the way the Admin looks and how moderation works. + +### Creating a Custom Moderation Queue + +Talk can support custom pluggable mod queues, meaning you can write a plugin that has some logic and determines which comments should appear there. This works by adding a field modQueues` in the `index.js` of your client side plugin, like so: + +``` + modQueues: { + newQueueKey: { + + // name + name: 'My Queue Name', + + // material design icon + icon: 'star', + + // Filter by tags + tags: ['MY_TAG'], + + // Filter by statuses + statuses: ['NONE', 'PREMOD', 'ACCEPTED', 'REJECTED'], + + // Filter by comment containing action_type + action_type: 'FLAG', + + }, + }, +``` + + +So if we wanted to make a Featured queue, we could do this like so: + +``` + modQueues: { + featured: { + tags: ['FEATURED'], + icon: 'star', + name: 'Featured', + }, + }, +``` + +For more information, see here: https://github.com/coralproject/talk/pull/849 + +### Flag Details + +To show more detailed information about reporting/flags, you can enable `talk-plugin-flag-details`.