Commit Graph

225 Commits

Author SHA1 Message Date
immber 4e464c48df Docs update- Jul 2020 (#3056)
* added existing closing stories behavior

* updated find your embed

* updated sso docs

* updated graphiql section

* clarified A user, not all the users

* clarified manual override on open/close stories

* clarified uniqueness constraints on sso

Co-authored-by: jessie.rushing <jessie.rushing@voxmedia.com>
2020-08-03 18:28:40 +00:00
Vinh fd64469c00 [DOCS] CSS Variables (#3015)
* docs: document css variables

* Update 02-04-css.md
2020-07-16 17:20:56 -04:00
Wyatt Johnson e488e878d0 feat: updated docs (#2998) 2020-06-25 09:21:24 -06:00
Wyatt Johnson 9f9f5a8a8e Bump 4.11.6 (#2997)
* chore: bump version

* fix: update docs
2020-06-23 19:06:19 +00:00
Andrew Losowsky 9109d5ab71 Added moderation queues detail (#2985)
Should these go into a separate 'Moderation' menu item below 'Admin Settings'?
2020-06-11 22:12:25 +00:00
Vinh 104b719dec docs: bodyClassName (#2970) 2020-06-01 14:12:21 -04:00
Wyatt Johnson 9e0d35e737 docs: added docs for FORCE_SSL (#2918) 2020-03-30 20:36:05 +00:00
Wyatt Johnson 21f436255e fix: fixed bug with plugin docs (#2896) 2020-03-18 16:55:13 +00:00
Wyatt Johnson 6ba7a43cb4 [DOCS] 6.0.0 Release (#2888)
* docs: added docs for 6.0.0 release

* fix: restored url docs
2020-03-17 17:12:50 +00:00
Andrew Losowsky 331a83d1fc Changed title, small updates (#2875) 2020-03-06 10:59:09 -05:00
immber 8d3de4b082 [DOCS DAY] added event tracking to v5 section (#2857)
* added event tracking to v5 section

* Add SEO docs and cleanup sidebar

* Fixes raw html in SSO docs

* fixed typo on sso page

Co-authored-by: Kim Gardner <kgardnr@gmail.com>
Co-authored-by: Vinh <vinh@vinh.tech>
2020-02-26 12:29:42 -05:00
Nick Funk c4801abfbe Break contributing out into sub-sections (#2862)
Main section links to main contributing guidelines
on the main GitHub repo.

Second subsection details translation contributions.

Co-authored-by: Kim Gardner <kgardnr@gmail.com>
2020-02-25 18:15:39 -05:00
Kim Gardner c0861c20d3 [CORL-880] SEO & iframe docs (#2859)
* Add SEO docs and cleanup sidebar

* Fixes raw html in SSO docs
2020-02-25 17:59:07 -05:00
Tessa Thornton 63545a48c4 add docs for user.url jwt claim (#2835) 2020-02-19 14:40:15 -05:00
Vinh e1bfe5b608 [Docs] Notes about IE11 compatibility (#2810)
* docs: ie11

* fix: wordings
2020-01-29 15:27:01 -05:00
Andrew Losowsky dc096137e3 Minor grammatical changes (#2793) 2020-01-14 16:41:05 +00:00
immber 4d41d999fb CORL-753 | DOCs Updates (#2776)
* added storyURL and storyID

* added story scraping section

* fixed typo on sso

* rebaseing on latest release/4 branch

* updated version on slack docs

* added Contributing a Translation section to developing

* fixing typos

* updated v5 config page, reorder list, add toc

* added cli sect, fixed contact menu link

* updated talk to coral on contact page

* added a new v5 auth section

* added session length to auth docs

* added an admin settings page to v5

* added v5 css section

* added a v5 notifications section

* updated faq and troubleshooting, moved out of v4 menu

* added migrating to v5 and moved migrating section out of v4

* added plugins note to migration pg

* fix: linting and extra HTML

* change sidebar migrating v5 to v5.0+

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* downtime being likely is too optimistic, it will be required

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* rewords plugins note on migrating to v5

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* tag code block as html

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* added link to contributing

* rephrased openid connect description

* fixed link to contributing

* correcting descriptions of email auth behavior

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* Adding link to css classnames

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* renamed new auth to Social and Email Authentication

* pulled extra line breaks

Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
2020-01-08 21:25:58 +00:00
Nick Funk b50d3dc96f Add missing environment variables to v5 config docs (#2770)
DISABLE_CLIENT_ROUTES
DISABLE_RATE_LIMITERS
SCRAPE_TIMEOUT
DISABLE_FORCE_SSL

CORL-806

Co-authored-by: Kim Gardner <kgardnr@gmail.com>
2019-12-23 11:26:29 -05:00
Hans Sprecher 8c0f55af21 Update version-5-installation.md (#2771)
* Update version-5-installation.md

The command `npm run start` doesn't work locally following these directions, but `npm run start:development` does. Based on the package.json commands, the `:development` command seems reasonable:

```
    "start": "NODE_ENV=production node dist/index.js",
    "start:development": "NODE_ENV=development CONCURRENCY=${CONCURRENCY:-1} TS_NODE_PROJECT=./src/tsconfig.json ts-node-dev --inspect --transpile-only --no-notify -r tsconfig-paths/register ./src/index.ts",
```

Here's the output I received from `npm run start`:

```
Hanss-MBP:talk [redacted]$ npm run start

> @coralproject/talk@5.4.0 start /Users/[redacted]/workspace/talk
> NODE_ENV=production node dist/index.js

{"name":"coral","clusterNode":"master","hostname":"[redacted].com","pid":25656,"level":50,"err":{"message":"SIGNING_SECRET is required in production environments","name":"Error","stack":"new Server (src/core/server/index.ts:126:15)\nObject.createCoral [as default] (src/core/index.ts:10:10)\nbootstrap (src/index.ts:76:20)\nObject.bootstrap (src/index.ts:109:1)\nModule._compile (internal/modules/cjs/loader.js:959:30)\nObject.Module._extensions..js (internal/modules/cjs/loader.js:995:10)\nModule.load (internal/modules/cjs/loader.js:815:32)\nFunction.Module._load (internal/modules/cjs/loader.js:727:14)\nFunction.Module.runMain (internal/modules/cjs/loader.js:1047:10)\ninternal/main/run_main_module.js:17:11\n"},"msg":"can not bootstrap server","time":"2019-12-20T23:27:38.314Z","src":{"file":"/Users/[redacted]/workspace/talk/src/index.ts","line":104,"func":"error"},"v":0}
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! @coralproject/talk@5.4.0 start: `NODE_ENV=production node dist/index.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the @coralproject/talk@5.4.0 start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/[redacted]/.npm/_logs/2019-12-20T23_27_38_335Z-debug.log
```

* fix: expanded on docs

Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
2019-12-21 00:14:32 +00:00
Nick Funk 5580e14bf3 Create Slack integration documentation (#2714)
Explains how to create a Slack App and hook it into
Coral as well as how to re-find your webhook URLs
if you have lost them.

CORL-645
2019-12-03 16:06:52 -05:00
Wyatt Johnson 109d9e93f5 docs: added doc updates for Node 12 (#2730) 2019-11-22 23:40:11 +00:00
Kim Gardner ff72d79748 Update SSO docs and add GDPR docs (#2701)
* Update SSO docs and add GDPR docs

* Update docs/source/version-5-gdpr.md

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* Update docs/source/version-5-gdpr.md

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>

* Update docs/source/version-5-gdpr.md

Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com>
2019-11-12 14:47:05 -05:00
Wyatt Johnson ca10062498 [CORL-646] Docs update (#2648)
* docs: added docs for trust proxy

* fix: adjusted incorrect HTML

- fixes #2656
2019-10-22 17:01:48 +00:00
Andrew Losowsky 13853ef87e Added notes about hosting and improved sell (#2638) 2019-10-15 14:20:28 -04:00
Vinh d3931db285 [CORL-181] Add docs for comment count integration (#2598)
* docs: add docs for comment count integration

* docs: update count docs

* chore: improve integration docs
2019-10-01 19:27:00 +00:00
Wyatt Johnson 4445479237 chore: updated minimum mongo versions (#2592) 2019-09-30 16:15:24 +00:00
Andrew Losowsky aab44587a6 Small changes (#2599)
Name change and small edit
2019-09-30 15:59:03 +00:00
immber 0af28edbd9 fixed broken links, added username restrictions, minor docs updates (#2580) 2019-09-20 19:31:20 +00:00
Wyatt Johnson 9db7571fe2 fix: fixed heroku install button (#2552) 2019-09-10 19:40:41 +00:00
Wyatt Johnson 683adceec4 [CORL-603] Documentation Updates (#2553)
* fix: replaced png with svg

* feat: updated docs

* feat: added netlify config

* fix: fixed netlify config
2019-09-10 19:20:24 +00:00
Wyatt Johnson aa6058e9d1 [CORL-584] Add Version 5 Documentation (#2523)
* feat: initial version

* fix: adjusted height

* fix: tweaked sidebar styles again

* fix: adjusted overflow property

* fix: reverted overflow, cleaned sidebar
2019-09-05 20:53:03 +00:00
immber 340052cdf0 DOCS | Add asset_url note to CMS integration & Update FB config (#2393)
* added note RE passing asset_url, and updated fb configs

* fix: syntax tweaks

* feat: small tweaks to embedding
2019-07-10 09:41:52 -07:00
Kim Gardner b99161f0cb Merge branch 'master' into next-amp-docs 2019-05-29 12:59:22 +01:00
immber 73aa77d7da CORL-380 | DOCS | Updates pre-launch checklist, asset scraping (#2317)
* updated asset scraping docs

* added note about setting close date

* added close window setting details
2019-05-27 17:58:18 +02:00
Chi Vinh Le 40eb0e97ec docs: add amp docs 2019-05-27 17:19:05 +02:00
Wyatt Johnson 1e3d47eb87 Tags Permissions (#2291)
* fix: fixed a bug that exposed tags

* chore: bumped versions
2019-04-29 22:28:49 +02:00
Andrew Losowsky a6653152e4 added info box (#2281)
* added info box

* fix: styles
2019-04-23 22:08:48 +00:00
Kim Gardner 1c2ff7d2ae Update default plugins and docs (#2265)
* Update default plugins

* Update plugin docs with missing plugin

* Fixed broken link in docs

* Update Code of Conduct in docs

* Fix mixup that both plugins are moderation-actions

* fix: adapt server tests to use the rich text plugin

* fix: e2e

* fix: sync docs
2019-04-16 20:54:44 +02:00
Kim Gardner cd4ae47958 [Docs] Initial list of events you can track from Talk (#2262)
* Initial list of events you can track from Talk

* Remove duplicates

* Remove more duplicates
2019-04-08 19:01:42 +02:00
immber ea34c936d0 DOCS || CORL-290 || Add Custom SSO Plugin Recipe (#2249)
* updated auth strategies

* added custom auth plugin recipe

* fixed format on TALK_SMTP_FROM_ADDRESS

* cleaned up formatting a bit

* added CDN to checklist

* Update docs/source/01-05-pre-launch-checklist.md

Co-Authored-By: immber <jessiekrushing@gmail.com>

* Update docs/source/integrating/authentication.md

Co-Authored-By: immber <jessiekrushing@gmail.com>

* added links to plugins
2019-04-01 22:23:22 +00:00
Mendel Konikov ef1fd9c159 Clarify that Reliable commenter is also not yet in use (#2253) 2019-04-01 21:14:04 +00:00
Jessie Rushing 9aec6b026c updated event tracking page 2019-03-22 13:25:40 -07:00
Wyatt Johnson 12c4cfbbf6 feat: improved server api docs 2019-03-19 16:24:32 -06:00
Jessie Rushing c875a8d9ed added note about subdomain whitelisting 2019-03-19 16:24:32 -06:00
Jessie Rushing 4d082165aa update tokenUserNotFound docs 2019-03-19 16:24:31 -06:00
Andrew Losowsky 53367eeaac Updated text to include our pricing page (#2221)
A few updates plus corrections.
2019-03-11 22:58:50 +00:00
David Burke 14f1343930 Additional Replies Increment (#2203)
* added ADDTL_REPLIES_ON_LOAD_MORE variable

* feat: added docs and onbuild ref
2019-02-26 16:18:55 +00:00
immber 582d45bb21 moved pdf to wp and updated copy 2019-01-17 09:56:55 -08:00
immber 00883a3739 added link to sidebar 2019-01-16 14:25:52 -08:00
immber d7fb0056be added native comments pdf 2019-01-16 14:16:04 -08:00