mirror of
https://github.com/wassname/talk.git
synced 2026-07-11 22:18:12 +08:00
Merge branch 'master' into docs-update
This commit is contained in:
immber
@@ -0,0 +1,181 @@
|
||||
---
|
||||
title: Configuration with CLI tools
|
||||
permalink: /configuration-cli-tools/
|
||||
class: configuration
|
||||
toc: true
|
||||
---
|
||||
|
||||
Talk can be configured using CLI tools. The CLI tools are available through `./bin/cli`. Below is a list of commands available:
|
||||
```
|
||||
Usage: cli [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
serve serve the application
|
||||
db run database commands
|
||||
settings interact with the application settings
|
||||
assets interact with assets
|
||||
setup setup the application
|
||||
jobs work with the job queues
|
||||
token work with the access tokens
|
||||
users work with the application auth
|
||||
migration provides utilities for migrating the database
|
||||
plugins provides utilities for interacting with the plugin system
|
||||
help [cmd] display help for [cmd]
|
||||
```
|
||||
|
||||
## Serving the application
|
||||
To serve the application, run `./bin/cli serve`. Please check that you have installed the Talk before doing this step. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-serve [options]
|
||||
|
||||
Options:
|
||||
|
||||
-j, --jobs enable job processing on this thread
|
||||
--disabled-jobs <jobs> disable jobs specified if the -j option is passed, specified as a comma separated list (default: )
|
||||
-w, --websockets enable the websocket (subscriptions) handler on this thread
|
||||
-h, --help output usage information
|
||||
```
|
||||
|
||||
## Database commands
|
||||
You can also run database commands using `./bin/cli db`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-db [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
createIndexes creates the database indexes and waits until they are created
|
||||
```
|
||||
|
||||
## Application settings
|
||||
You can also change application settings using `./bin/cli settings`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-settings [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
change-org-name change the organization name
|
||||
```
|
||||
|
||||
## Interaction with assets
|
||||
You can also interact with your application's assets using `./bin/cli assets`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-assets [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
list [options] list all the assets in the database
|
||||
refresh [age] queues the assets that exceed the age requested
|
||||
update-url <assetID> <url> update the URL of an asset
|
||||
merge <srcID> <dstID> merges two assets together by moving comments from src to dst and deleting the src asset
|
||||
rewrite [options] <search> <replace> rewrites asset url's using the provided regex replacement pattern
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
You can also run a setup wizard to setup the wizard using `./bin/cli setup`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-setup [options]
|
||||
|
||||
runs the setup wizard to setup the application
|
||||
|
||||
Options:
|
||||
|
||||
--defaults apply defaults for config instead of prompting
|
||||
-h, --help output usage information
|
||||
```
|
||||
|
||||
## Working with job queues
|
||||
You can also work with job queues using `./bin/cli jobs`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-jobs [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
process starts job processing
|
||||
cleanup [options] cleans up inactive jobs
|
||||
```
|
||||
|
||||
## Working with access tokens
|
||||
You can also work with access tokens using `./bin/cli token`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-token [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
list <userID> list tokens for a user
|
||||
revoke <tokenID> revokes a token with a given id
|
||||
create <userID> <tokenName> create a token for a user with a given name
|
||||
```
|
||||
|
||||
## Working with your application's authentication
|
||||
You can also work with your application's authentication using `./bin/cli users`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-users [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
create creates a local user
|
||||
delete <userID> delete a user
|
||||
list searches for a user based on their stored username and email
|
||||
set-role <userID> sets the role on a user
|
||||
verify <userID> <email> verifies the given user's email address
|
||||
```
|
||||
|
||||
## Migrating your database
|
||||
Talk provides utilities for migrating your database using `./bin/cli migration`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-migration [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
create <name> creates a new migration
|
||||
run [options] runs all pending migrations
|
||||
```
|
||||
|
||||
## Interacting with the plugin system
|
||||
Talk provides utilities to interact with the plugin system using `./bin/cli plugins`. Below is a list of additional options available for this command:
|
||||
```
|
||||
Usage: cli-plugins [options] [command]
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help output usage information
|
||||
|
||||
Commands:
|
||||
|
||||
create creates a seed plugin
|
||||
list
|
||||
reconcile [options] reconciles dependencies by downloading external plugins
|
||||
```
|
||||
@@ -58,7 +58,7 @@ This queue contains comments that have been reported for moderator review, eithe
|
||||
The All queue contains all comments that have been submitted either article or
|
||||
site-wide.
|
||||
|
||||
#### Moderation Tags
|
||||
#### Moderation Tags that appear in Reported/other queues
|
||||
|
||||
**Pre-mod**
|
||||
|
||||
@@ -88,7 +88,7 @@ Comment contains a word or phrase that is on the ’Suspect words’ list in the
|
||||
|
||||
_Comment published? No_
|
||||
|
||||
The History tag signifies comments that have been flagged because the user’s history indicates their Accepted:Rejected ratio has reached below the karma threshold. [Read more here...](/talk/trust/#user-karma-score)
|
||||
The History tag signifies comments that have been flagged because the user’s history indicates their Accepted:Rejected ratio has reached below the karma threshold. [Read more about karma here.](/talk/trust/#user-karma-score)
|
||||
|
||||
**Spam**
|
||||
|
||||
@@ -130,9 +130,35 @@ Rejecting a comment removes the comment from the stream.
|
||||
Featuring a comment adds that comment to the Featured Comments tab on the
|
||||
stream.
|
||||
|
||||
#### Keyboard Shortcuts
|
||||
|
||||
Talk also supports a number of keyboard shortcuts that moderators can leverage
|
||||
to moderate queues quickly:
|
||||
|
||||
| Shortcut | Action |
|
||||
| -------- | -------------------------- |
|
||||
| `j` | Go to the next comment |
|
||||
| `k` | Go to the previous comment |
|
||||
| `ctrl+f` | Open search |
|
||||
| `1-5` | Switch queues |
|
||||
| `z` | Zen mode |
|
||||
| `?` | Open shortcuts menu |
|
||||
| `d` | Approve |
|
||||
| `f` | Reject |
|
||||
|
||||
Note: "Zen mode" allows a moderator to view and action only one comment at a time. Enjoy the silence!
|
||||
|
||||
#### The User Drawer
|
||||
|
||||
In order to get an idea of what sort of a commenter someone is, moderators can
|
||||
click on the commenter's username in any moderation queue/elsewhere in the admin (eg the Community page) to see details about
|
||||
their comments, and to take actions.
|
||||
|
||||
#### User Drawer Actions
|
||||
|
||||
**Suspend User**
|
||||
|
||||
Suspending a user allows a moderator to give a commenter a “time-out”; during
|
||||
Suspending a user allows a moderator to give a commenter a “time-out” for a set time chosen from four options; during
|
||||
that time they won’t be allowed to post comments or react to comments.
|
||||
|
||||
**Ban User**
|
||||
@@ -141,15 +167,13 @@ Banning a user allows a moderator to permanently disallow a commenter to
|
||||
interact with their community. The commenters previous comments will remain on
|
||||
the site. This action can only be un-done manually by a moderator.
|
||||
|
||||
#### Viewing a User’s Comment History
|
||||
**Reject Username**
|
||||
|
||||
In order to get an idea of what sort of a commenter someone is, moderators can
|
||||
click on the commenters username in any moderation queue and see details about
|
||||
their history.
|
||||
If a username is violating your guidelines but isn't bad enough to lead to a ban (eg. they are impersonating a famous person), you can reject their username. This will prevent them from publishing comments until they submit a new username. The new name will appear on the Community page for moderator approval before they can publish comments again.
|
||||
|
||||
**Username, Email and Member Since Date**
|
||||
|
||||
This shows the basic details about a commenter.
|
||||
This shows the basic details about a commenter's account
|
||||
|
||||
**Total Comments**
|
||||
|
||||
@@ -161,32 +185,17 @@ display on the site.
|
||||
This shows the % of comments a commenter has had rejected by moderators, or
|
||||
automatically.
|
||||
|
||||
**Reports**
|
||||
**Karma score**
|
||||
|
||||
This shows if a commenter is a reliable flagger, an unreliable flagger, or a
|
||||
neutral flagger. [Read more about reliable and unreliable flaggers here](/talk/trust/#reliable-and-unreliable-flaggers).
|
||||
The user's current score. To see the default threshhold, click on the 'i' next to the word Karma. If the user's score is equal to or below the default threshhold, the number will be highlighted red. [Read more about karma scores here.](/talk/trust/#user-karma-score)
|
||||
|
||||
**User History**
|
||||
|
||||
This shows the history of the account - if a user has changed their username, or been suspended or banned. The name of the moderator who suspended/banned them/lifted the suspection or ban is displayed here as well.
|
||||
|
||||
**Moderating from this View**
|
||||
|
||||
Talk also allows you to moderate a commenters recent comments from this view.
|
||||
|
||||
#### Keyboard Shortcuts
|
||||
|
||||
Talk also supports a number of keyboard shortcuts that moderators can leverage
|
||||
to moderate quickly:
|
||||
|
||||
| Shortcut | Action |
|
||||
| -------- | -------------------------- |
|
||||
| `j` | Go to the next comment |
|
||||
| `k` | Go to the previous comment |
|
||||
| `ctrl+f` | Open search |
|
||||
| `t` | Switch queues |
|
||||
| `z` | Zen mode |
|
||||
| `?` | Open this menu |
|
||||
| `d` | Approve |
|
||||
| `f` | Reject |
|
||||
|
||||
Note: "Zen mode" allows a moderator to view and action only one comment at a time. Enjoy the silence!
|
||||
Talk also allows you to moderate a commenters recent comments from this view. You can 'Select all' to select up to ten previous comments, and take bulk accept/reject actions.
|
||||
|
||||
### Stories
|
||||
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Asset Scraping
|
||||
permalink: /integrating/asset-scraping/
|
||||
---
|
||||
|
||||
By default, Assets in Talk have their metadata scraped when they are loaded.
|
||||
This provides the easiest way for newsrooms to integrate their CMS's into Talk
|
||||
in a simple way. We use the following
|
||||
[meta tags](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta) on
|
||||
the target pages that allow us to extract some properties.
|
||||
|
||||
| Asset Property | Selector |
|
||||
|--------------------|----------|
|
||||
| `title` | See [`metascraper-title`](https://github.com/microlinkhq/metascraper/blob/dc664c37ea1b238b1e3e9d5342edfacc9027892c/packages/metascraper-title/index.js) |
|
||||
| `description` | See [`metascraper-description`](https://github.com/microlinkhq/metascraper/blob/dc664c37ea1b238b1e3e9d5342edfacc9027892c/packages/metascraper-description/index.js) |
|
||||
| `image` | See [`metascraper-image`](https://github.com/microlinkhq/metascraper/blob/dc664c37ea1b238b1e3e9d5342edfacc9027892c/packages/metascraper-image/index.js) |
|
||||
| `author` | See [`metascraper-author`](https://github.com/microlinkhq/metascraper/blob/dc664c37ea1b238b1e3e9d5342edfacc9027892c/packages/metascraper-author/index.js) |
|
||||
| `publication_date` | See [`metascraper-date`](https://github.com/microlinkhq/metascraper/blob/dc664c37ea1b238b1e3e9d5342edfacc9027892c/packages/metascraper-date/index.js) |
|
||||
| `modified_date` | `meta[property="article:modified"]` |
|
||||
| `section` | `meta[property="article:section"]` |
|
||||
|
||||
You can use the `./bin/cli assets debug <url>` to print the scraped metadata
|
||||
from that URL. For example:
|
||||
|
||||
```bash
|
||||
$ ./bin/cli assets debug https://www.washingtonpost.com/technology/2018/10/30/apple-event-october-ipad-pro-macbook-air/
|
||||
┌──────────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
|
||||
│ Property │ Value │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ title │ Apple redesigns the iPad Pro, breathes new life in the MacBook Air │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ description │ Apple is unveiling new iPads and MacBooks at an event in New York starting at 10 a.m. Fowler is there and will report in with the news and hands-on analysis throughout the day. │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ image │ https://www.washingtonpost.com/resizer/JAwNQE2alL2JjiWrbXeJ46wZHqA=/1484x0/arc-anglerfish-washpost-prod-washpost.s3.amazonaws.com/public/G5TWBFW4LAI6RC5MX7QB7TODUY.jpg │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ author │ Geoffrey A. Fowler │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ publication_date │ 2018-10-30T10:40:00.000Z │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ modified_date │ │
|
||||
├──────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
|
||||
│ section │ │
|
||||
└──────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
Reference in New Issue
Block a user