From cce464b82ac9cae6fe207534075191c929c59a2a Mon Sep 17 00:00:00 2001 From: immber Date: Wed, 28 Nov 2018 13:56:31 -0800 Subject: [PATCH 01/18] merging in typo fixes from docs (rtd) branch --- docs/.gitignore | 3 ++- docs/source/01-01-talk-quickstart.md | 2 ++ docs/source/integrating/asset-management.md | 11 ++++++----- scripts/generateIntrospectionResult.js | 12 +++++++++--- 4 files changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/.gitignore b/docs/.gitignore index be0603043..6c8794979 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -3,4 +3,5 @@ public/* .deploy*/ db.json *.log -source/_data/introspection.json \ No newline at end of file +source/_data/introspection.json +rtd/build/* \ No newline at end of file diff --git a/docs/source/01-01-talk-quickstart.md b/docs/source/01-01-talk-quickstart.md index 8478ed0f2..e85e09e1e 100644 --- a/docs/source/01-01-talk-quickstart.md +++ b/docs/source/01-01-talk-quickstart.md @@ -187,8 +187,10 @@ and walk through the initial setup steps. * First, enter your **Organization Name** and **Organization Contact Email**. This will appear in emails when inviting new team members. * Next, create your Admin user. You can specify an **Email Address**, **Username**, and **Password** + * Finally, enter your list of **Permitted Domains**, read [here](/talk/configuring-talk/#permitted-domains) about whitelisting domains + _During development, ensure you whitelist 127.0.0.1:3000 otherwise the [http://127.0.0.1:3000/](http://127.0.0.1:3000/) page will not load._ diff --git a/docs/source/integrating/asset-management.md b/docs/source/integrating/asset-management.md index 52bb11b69..4a1de24ea 100644 --- a/docs/source/integrating/asset-management.md +++ b/docs/source/integrating/asset-management.md @@ -18,11 +18,12 @@ By default, Talk will use "Lazy Asset Creation" to dynamically generate Assets in Talk in order to make it easier for lighter installations. In order to have more strict control over this flow, we will create a plugin that will: -1. Disable "Lazy Asset Creation" by [Overriding a Resolver](#overriding-a-resolver). -2. Create Assets from our CMS by [Creating a New Asset Route](#creating-a-new-asset-route). -3. Facilitate updates from our CMS to keep Talk in sync by [Creating an Asset Update Route](#creating-an-asset-update-route). -We will then modify our embed so that we can [Target the Asset](#target-the-asset). +1. Disable "Lazy Asset Creation" by [Overriding a Resolver](#Overriding%20a%20Resolver). +2. Create Assets from our CMS by [Creating a New Asset Route](#Creating%20a%20New%20Asset%20Route). +3. Facilitate updates from our CMS to keep Talk in sync by [Creating an Asset Update Route](#Creating%20an%20Asset%20Update%20Route). + +We will then modify our embed so that we can [Target the Asset](#Target%20the%20Asset). But first we should grab our basic plugin structure: @@ -248,7 +249,7 @@ module.exports = router => { }; ``` -As you can see from the previous step of [Creating a New Asset Route](#creating-a-New-Asset-Route) +As you can see from the previous step of [Creating a New Asset Route](#Creating%20a%20New%20Asset%20Route) , we have added the new `PUT` route to the router. This is a simple addition that allows your CMS to call into Talk when the asset has updated it's title, it's url (or really anything in the [AssetSchema](https://github.com/coralproject/talk/blob/master/models/asset.js)) to keep the Talk Admin and links up to date. diff --git a/scripts/generateIntrospectionResult.js b/scripts/generateIntrospectionResult.js index 6f289e8e8..b4e788fc1 100755 --- a/scripts/generateIntrospectionResult.js +++ b/scripts/generateIntrospectionResult.js @@ -112,10 +112,14 @@ const generateIntrospectionResult = async (resultLocation, options = {}) => { return; } - const { data } = await graphql(schema, getIntrospectionQuery(options)); + const result = await graphql(schema, getIntrospectionQuery(options)); // Serialize the introspection result as JSON. - const introspectionResult = JSON.stringify(data, null, 2); + const introspectionResult = JSON.stringify( + options.raw ? result : result.data, + null, + 2 + ); // Write the introspection result to the filesystem. fs.writeFileSync(resultLocation, introspectionResult, 'utf8'); @@ -145,7 +149,9 @@ Promise.all([ generateIntrospectionResult(graphIntrospectionFilename, { descriptions: false, }), - generateIntrospectionResult(docsIntrospectionFilename), + generateIntrospectionResult(docsIntrospectionFilename, { + raw: true, + }), ]).catch(err => { console.error(err); process.exit(1); From 5ae293af89c8e2697c00bf27997dc4b8b743a757 Mon Sep 17 00:00:00 2001 From: immber Date: Wed, 28 Nov 2018 13:58:56 -0800 Subject: [PATCH 02/18] revert generateIntrospectionResult.json --- scripts/generateIntrospectionResult.js | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/scripts/generateIntrospectionResult.js b/scripts/generateIntrospectionResult.js index b4e788fc1..6f289e8e8 100755 --- a/scripts/generateIntrospectionResult.js +++ b/scripts/generateIntrospectionResult.js @@ -112,14 +112,10 @@ const generateIntrospectionResult = async (resultLocation, options = {}) => { return; } - const result = await graphql(schema, getIntrospectionQuery(options)); + const { data } = await graphql(schema, getIntrospectionQuery(options)); // Serialize the introspection result as JSON. - const introspectionResult = JSON.stringify( - options.raw ? result : result.data, - null, - 2 - ); + const introspectionResult = JSON.stringify(data, null, 2); // Write the introspection result to the filesystem. fs.writeFileSync(resultLocation, introspectionResult, 'utf8'); @@ -149,9 +145,7 @@ Promise.all([ generateIntrospectionResult(graphIntrospectionFilename, { descriptions: false, }), - generateIntrospectionResult(docsIntrospectionFilename, { - raw: true, - }), + generateIntrospectionResult(docsIntrospectionFilename), ]).catch(err => { console.error(err); process.exit(1); From bac0ee9c3b2ff9418dfa9197cfbc5c21288119a2 Mon Sep 17 00:00:00 2001 From: immber Date: Wed, 28 Nov 2018 14:00:07 -0800 Subject: [PATCH 03/18] revert git ignore --- docs/.gitignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/.gitignore b/docs/.gitignore index 6c8794979..be0603043 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -3,5 +3,4 @@ public/* .deploy*/ db.json *.log -source/_data/introspection.json -rtd/build/* \ No newline at end of file +source/_data/introspection.json \ No newline at end of file From e9cec73966253658a3f8cc1ba23227839147b5ad Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 14:44:35 -0800 Subject: [PATCH 04/18] added asset mgmt to prelaunch checklist --- docs/source/01-05-pre-launch-checklist.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/01-05-pre-launch-checklist.md b/docs/source/01-05-pre-launch-checklist.md index d30419e01..23e7d48a6 100644 --- a/docs/source/01-05-pre-launch-checklist.md +++ b/docs/source/01-05-pre-launch-checklist.md @@ -28,6 +28,8 @@ permalink: /pre-launch-checklist/ - [ ] Do you want to provide single sign-on (SSO) by integrating with an external auth system? - See [Authenticating with Talk](/talk/integrating/authentication/) +- [ ] Do you want to integrate Talk with your CMS to automate embedding Talk Comment Stream into your site? + - See [Asset Management](/talk/integrating/asset-management/) - [ ] Do you want to use Social sign-on? - Facebook From 4659392ad383b9533c957d6f1840a164cbefb915 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 15:10:00 -0800 Subject: [PATCH 05/18] updated cusotm plugin docker onbuild instructions --- docs/source/plugins/overview.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/source/plugins/overview.md b/docs/source/plugins/overview.md index 2e8a9c2a5..1f734edeb 100644 --- a/docs/source/plugins/overview.md +++ b/docs/source/plugins/overview.md @@ -105,6 +105,8 @@ Then the application can be started as is. ### Docker +To deploy customized plugins to a production instance of Talk, we recommend using the Docker onbuild strategy outlined below. + If you deploy using Docker, you can extend from the `*-onbuild` image, an example `Dockerfile` for your project could be: @@ -112,14 +114,22 @@ example `Dockerfile` for your project could be: FROM coralproject/talk:4.5-onbuild ``` -Where the directory for your instance would contain a `plugins.json` file -describing the plugin requirements and a `plugins` directory containing any +Establish a private repository for your instance that includes the following: + +* a `plugins.json` file +listing the plugin requirements +* a `plugins` directory containing any other local plugins that should be included. +* a Dockerfile as outlined above + +Git submodules can also be used to point to plugin directories that might be outside your primary repository. Onbuild triggers will execute when the image is building with your custom configuration and will ensure that the image is ready to use by building all assets inside the image as well. +Once built, you can deploy the docker image to your architecture by tagging the image and including it in your docker-compose.yml. + For more information on the onbuild image, refer to the [Installation from Docker](/talk/installation-from-docker/) documentation. From 76c959f790cb332357d0f8b215a0cf86a7746c94 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 17:11:42 -0800 Subject: [PATCH 06/18] add google to auth options --- docs/source/integrating/authentication.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/source/integrating/authentication.md b/docs/source/integrating/authentication.md index 77315a9d8..1e5567289 100644 --- a/docs/source/integrating/authentication.md +++ b/docs/source/integrating/authentication.md @@ -3,8 +3,10 @@ title: Authenticating with Talk permalink: /integrating/authentication/ --- -You can integrate Talk with any external authentication service that will enable -seamless single sign-on for users within your organization. There are a few +Out of the box Talk supports account registration with username and password, as well as features like forgot password. + +You can also integrate Talk with any external authentication service that will enable +seamless single sign-on (SSO) for users within your organization. There are a few methods of doing so: 1. Passport Middleware @@ -17,8 +19,12 @@ choice. You would choose the **Passport Middleware** route when you are OK using an auth that is triggered from inside Talk that is not connected to an external auth -state (you don't use the auth anywhere else now). A great example of this is our -[talk-plugin-facebook-auth](/talk/plugin/talk-plugin-facebook-auth/) plugin. +state (you don't use the auth anywhere else now). + +Plugins are available for the follwing 3rd party authentication providers: + +* [Facebook](/talk/plugin/talk-plugin-facebook-auth/) +* [Google](/talk/plugin/talk-plugin-google-auth/) ## Custom Token Integration From 847ded5bb47cb9d18d7d52a0628dec19b5a1cc0b Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 17:19:27 -0800 Subject: [PATCH 07/18] add google to auth options --- docs/source/03-02-product-guide-commenter-features.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/03-02-product-guide-commenter-features.md b/docs/source/03-02-product-guide-commenter-features.md index 3d60eeda9..c89e018e7 100644 --- a/docs/source/03-02-product-guide-commenter-features.md +++ b/docs/source/03-02-product-guide-commenter-features.md @@ -5,13 +5,15 @@ permalink: /commenter-features/ ## Signing up for Talk -There are 2 ways that newsrooms can support signup/login functionality with Talk: +There are 3 ways that newsrooms can support signup/login functionality with Talk: * Use Talk’s auth plugin out of the box (supports account registration with username and password, as well as features like forgot password) +* Use 3rd party authentication provider such as FaceBook or Google. We provide plugins that support logging in with either [Facebook](/talk/plugin/talk-plugin-facebook-auth/) +or [Google](/talk/plugin/talk-plugin-google-auth/). (Note: you must provide your own Facebook App ID and Secret, which you can read more about here: [https://developers.facebook.com](https://developers.facebook.com)) + * Create their own auth plugin to integrate with your own auth systems -We also provide a Facebook auth plugin that supports logging in with Facebook (you must provide your own Facebook App ID and Secret, which you can read more about here: [https://developers.facebook.com](https://developers.facebook.com)) ## Comments and Replies From 92681f52aa5943086886efc04ec10887c2497ab3 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 17:39:02 -0800 Subject: [PATCH 08/18] added yarn watch to from source --- docs/source/01-03-installation-from-source.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/01-03-installation-from-source.md b/docs/source/01-03-installation-from-source.md index 9f4b96d93..978ffedd0 100644 --- a/docs/source/01-03-installation-from-source.md +++ b/docs/source/01-03-installation-from-source.md @@ -70,5 +70,7 @@ You can now start the application by running: yarn watch:server ``` +If you are developing a custom plugin you can use `yarn watch:client` or `yarn watch` to run both client and server. + At this stage, you should refer to the [configuration](/talk/configuration/) for configuration variables that are specific to your installation. From 3668a2cffaabfd6390db321181f8c931da884004 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 17:56:20 -0800 Subject: [PATCH 09/18] added dev links to quickstart --- docs/source/01-01-talk-quickstart.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/source/01-01-talk-quickstart.md b/docs/source/01-01-talk-quickstart.md index e85e09e1e..c17170335 100644 --- a/docs/source/01-01-talk-quickstart.md +++ b/docs/source/01-01-talk-quickstart.md @@ -222,6 +222,17 @@ Once you have added the domain of these docs, you can click the button below.
+### Developer Endpoints + +With your local instance of Talk running in development mode (env variable `NODE_ENV=development`) you should now also be able to access the following developer routes: + +[http://127.0.0.1:3000/dev](http://127.0.0.1:3000/dev]) provides a sample comment stream + +[http://127.0.0.1:3000/dev/assets](http://127.0.0.1:3000/dev/assets]) provides a list of all stories in Talk and can generate new sample assets + +###Conclusion At this point you've successfully installed, configured, and ran your very own instance of Talk! Continue through this documentation on this site to learn more on how to configure, develop with, and contribute to Talk! + + From cfae6b53744766f7d63855ae7e11e5974a672ed2 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 18:04:20 -0800 Subject: [PATCH 10/18] typo on following --- docs/source/integrating/authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/integrating/authentication.md b/docs/source/integrating/authentication.md index 1e5567289..f834f3e53 100644 --- a/docs/source/integrating/authentication.md +++ b/docs/source/integrating/authentication.md @@ -21,7 +21,7 @@ You would choose the **Passport Middleware** route when you are OK using an auth that is triggered from inside Talk that is not connected to an external auth state (you don't use the auth anywhere else now). -Plugins are available for the follwing 3rd party authentication providers: +Plugins are available for the following 3rd party authentication providers: * [Facebook](/talk/plugin/talk-plugin-facebook-auth/) * [Google](/talk/plugin/talk-plugin-google-auth/) From 2fac30416352c84f273895e89a12214ed8ef1cd0 Mon Sep 17 00:00:00 2001 From: immber Date: Mon, 3 Dec 2018 09:33:03 -0800 Subject: [PATCH 11/18] fixed typos --- docs/source/01-01-talk-quickstart.md | 6 +++--- docs/source/01-05-pre-launch-checklist.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/01-01-talk-quickstart.md b/docs/source/01-01-talk-quickstart.md index c17170335..6c5ecb5d1 100644 --- a/docs/source/01-01-talk-quickstart.md +++ b/docs/source/01-01-talk-quickstart.md @@ -226,11 +226,11 @@ Once you have added the domain of these docs, you can click the button below. With your local instance of Talk running in development mode (env variable `NODE_ENV=development`) you should now also be able to access the following developer routes: -[http://127.0.0.1:3000/dev](http://127.0.0.1:3000/dev]) provides a sample comment stream +* [http://127.0.0.1:3000/dev](http://127.0.0.1:3000/dev]) provides a sample comment stream -[http://127.0.0.1:3000/dev/assets](http://127.0.0.1:3000/dev/assets]) provides a list of all stories in Talk and can generate new sample assets +* [http://127.0.0.1:3000/dev/assets](http://127.0.0.1:3000/dev/assets]) provides a list of all stories in Talk and can generate new sample assets -###Conclusion +### Conclusion At this point you've successfully installed, configured, and ran your very own instance of Talk! Continue through this documentation on this site to learn more on how to configure, develop with, and contribute to Talk! diff --git a/docs/source/01-05-pre-launch-checklist.md b/docs/source/01-05-pre-launch-checklist.md index 23e7d48a6..854ead062 100644 --- a/docs/source/01-05-pre-launch-checklist.md +++ b/docs/source/01-05-pre-launch-checklist.md @@ -23,7 +23,7 @@ permalink: /pre-launch-checklist/ - [ ] Do you need to migrate comments from a legacy system? We currently support Disqus, Livefyre, and Civil Comments. - Use the [Talk Import](https://github.com/coralproject/talk-importer) framework - + - [ ] Do you want to provide single sign-on (SSO) by integrating with an external auth system? - See [Authenticating with Talk](/talk/integrating/authentication/) From 99777d6b495cc7eb030a0ee92544300ed2692866 Mon Sep 17 00:00:00 2001 From: immber Date: Mon, 3 Dec 2018 11:07:40 -0800 Subject: [PATCH 12/18] fixing links --- docs/source/integrating/asset-management.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/integrating/asset-management.md b/docs/source/integrating/asset-management.md index 4a1de24ea..190b67c63 100644 --- a/docs/source/integrating/asset-management.md +++ b/docs/source/integrating/asset-management.md @@ -19,11 +19,11 @@ in Talk in order to make it easier for lighter installations. In order to have more strict control over this flow, we will create a plugin that will: -1. Disable "Lazy Asset Creation" by [Overriding a Resolver](#Overriding%20a%20Resolver). -2. Create Assets from our CMS by [Creating a New Asset Route](#Creating%20a%20New%20Asset%20Route). -3. Facilitate updates from our CMS to keep Talk in sync by [Creating an Asset Update Route](#Creating%20an%20Asset%20Update%20Route). +1. Disable "Lazy Asset Creation" by [Overriding a Resolver](#overriding-a-resolver). +2. Create Assets from our CMS by [Creating a New Asset Route](#creating-a-new-asset-route). +3. Facilitate updates from our CMS to keep Talk in sync by [Creating an Asset Update Route](#creating-an-asset-update-route). -We will then modify our embed so that we can [Target the Asset](#Target%20the%20Asset). +We will then modify our embed so that we can [Target the Asset](#target-the-asset). But first we should grab our basic plugin structure: From cd9cb56844a54835ac22747c3d197d8d30d222e3 Mon Sep 17 00:00:00 2001 From: immber Date: Wed, 12 Dec 2018 12:44:19 -0800 Subject: [PATCH 13/18] added lazy render and updated lazy load --- docs/source/integrating/asset-management.md | 75 ++++++++++++++++++--- 1 file changed, 66 insertions(+), 9 deletions(-) diff --git a/docs/source/integrating/asset-management.md b/docs/source/integrating/asset-management.md index 190b67c63..c70fda5cc 100644 --- a/docs/source/integrating/asset-management.md +++ b/docs/source/integrating/asset-management.md @@ -3,21 +3,75 @@ title: Asset Management permalink: /integrating/asset-management/ --- +## Embedding Comments on Your Site +Talk provides an embed script that you can drop into your site where you want a comments section to appear. By default that script dynamically generate Assets +in Talk in order to make it easier for lighter installations. + +You can find the embed script inside talk under `Configure > Tech Settings > Embed Script`. It should look something like this, but with your domain in place of ``: +``` +
+ +``` + +## Triggering the Comments Section (client side, i.e. Your site) + +When the embed script is triggered on your page load several things are initiated inside Talk, including fetching all comments for the specified article, establishing websocket connections for this user, and checking user’s session for SSO/authentication. + +Instead of greedily triggering the embed to render on _EVERY PAGE LOAD_, we highly recommend implementing a _“lazy”_ rendering strategy to only render the comments section if a user wants to interact with it. This will greatly improve your initial page load performance, and will be critical to managing server resources if you’re running Talk on a heavy-traffic production site. + +We recommend using one of these _“lazy”_ loading strategies: + +#### Scroll to Comments Section +Wait for user to scroll to the comment section before triggering the embed to render. + +You can pass lazy: true to the render options, like so: +``` +Coral.Talk.render(document.getElementById('container'), { + talk: 'https://my-talk-installation.com', + lazy: true, +}); +``` + +Or you can enable lazy rendering by default on all assets using ENV variable `TALK_DEFAULT_LAZY_RENDER=TRUE` + +#### Show Comments Button + You can hide the comments section until a user clicks button, then trigger the embed to render + +This example uses jQuery to render the embed on the button's click event +``` + + +
+ +
+ + +``` + +## Creating Assets in Talk (server side, i.e. What you need to send to Talk) One of the most frequent questions that we get asked by organizations trying to integrate Talk is: _How do we hook our CMS up to Talk so that articles are in sync?_ -This guide is designed to explain the steps to take your base installation of -Talk and configure it to allow only assets pushed into it from your CMS, and -keep your URL/title in sync. We won't cover here how to install the plugin, as -it is covered in our [Plugins Overview](/talk/plugins/). +### “Lazy Asset Creation” +Talk’s provided embed script by default dynamically generates Assets in Talk based on each unique url that triggers it. The url must reference an existing Permitted Domain. If your articles/stories always have unique urls, then you will not need to modify the default behavior. -## Why do we need to create a plugin? - -By default, Talk will use "Lazy Asset Creation" to dynamically generate Assets -in Talk in order to make it easier for lighter installations. In order to have -more strict control over this flow, we will create a plugin that will: +## Customizing the Integration with a Plugin +In order to have more strict control over the asset creation flow to allow only assets pushed into it from your CMS, and keep your URL/title in sync we will create a plugin. +We will create a plugin that will: 1. Disable "Lazy Asset Creation" by [Overriding a Resolver](#overriding-a-resolver). 2. Create Assets from our CMS by [Creating a New Asset Route](#creating-a-new-asset-route). @@ -25,6 +79,9 @@ more strict control over this flow, we will create a plugin that will: We will then modify our embed so that we can [Target the Asset](#target-the-asset). + +This guide is designed to explain the steps to take your base installation of Talk and configure it. We won't cover here how to install the plugin, as it is covered in our [Plugins Overview](/talk/plugins/). + But first we should grab our basic plugin structure: ```sh From 44830f6cb187e422c158fb853674192c4a6fc51d Mon Sep 17 00:00:00 2001 From: immber Date: Thu, 13 Dec 2018 12:51:50 -0800 Subject: [PATCH 14/18] added version note --- docs/source/integrating/asset-management.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/integrating/asset-management.md b/docs/source/integrating/asset-management.md index c70fda5cc..cae92340f 100644 --- a/docs/source/integrating/asset-management.md +++ b/docs/source/integrating/asset-management.md @@ -37,6 +37,7 @@ Coral.Talk.render(document.getElementById('container'), { ``` Or you can enable lazy rendering by default on all assets using ENV variable `TALK_DEFAULT_LAZY_RENDER=TRUE` +_*Note: This feature requires Talk version 4.6.8 or greater_ #### Show Comments Button You can hide the comments section until a user clicks button, then trigger the embed to render From 374951bd33861f33d6aff01f85a35fde528b6d74 Mon Sep 17 00:00:00 2001 From: immber Date: Thu, 13 Dec 2018 13:04:01 -0800 Subject: [PATCH 15/18] renamed asset management to cms-integration --- docs/_config.yml | 4 ++-- docs/source/01-05-pre-launch-checklist.md | 2 +- .../integrating/{asset-management.md => cms-integration.md} | 5 +++-- 3 files changed, 6 insertions(+), 5 deletions(-) rename docs/source/integrating/{asset-management.md => cms-integration.md} (99%) diff --git a/docs/_config.yml b/docs/_config.yml index 57fe6d666..d9de09850 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -104,8 +104,8 @@ sidebar: children: - title: Authentication url: /integrating/authentication/ - - title: Asset Management - url: /integrating/asset-management/ + - title: CMS Integration + url: /integrating/cms-integration/ - title: Asset Scraping url: /integrating/asset-scraping/ - title: Configuring the Comment Stream diff --git a/docs/source/01-05-pre-launch-checklist.md b/docs/source/01-05-pre-launch-checklist.md index 854ead062..01e42b9bd 100644 --- a/docs/source/01-05-pre-launch-checklist.md +++ b/docs/source/01-05-pre-launch-checklist.md @@ -29,7 +29,7 @@ permalink: /pre-launch-checklist/ - See [Authenticating with Talk](/talk/integrating/authentication/) - [ ] Do you want to integrate Talk with your CMS to automate embedding Talk Comment Stream into your site? - - See [Asset Management](/talk/integrating/asset-management/) + - See [CMS Integration](/talk/integrating/cms-integration/) - [ ] Do you want to use Social sign-on? - Facebook diff --git a/docs/source/integrating/asset-management.md b/docs/source/integrating/cms-integration.md similarity index 99% rename from docs/source/integrating/asset-management.md rename to docs/source/integrating/cms-integration.md index cae92340f..f832d15ae 100644 --- a/docs/source/integrating/asset-management.md +++ b/docs/source/integrating/cms-integration.md @@ -1,6 +1,6 @@ --- -title: Asset Management -permalink: /integrating/asset-management/ +title: CMS Integration +permalink: /integrating/cms-integration/ --- ## Embedding Comments on Your Site @@ -37,6 +37,7 @@ Coral.Talk.render(document.getElementById('container'), { ``` Or you can enable lazy rendering by default on all assets using ENV variable `TALK_DEFAULT_LAZY_RENDER=TRUE` + _*Note: This feature requires Talk version 4.6.8 or greater_ #### Show Comments Button From 7eed540671eb52a19f75f31bd8e3a321616c56b8 Mon Sep 17 00:00:00 2001 From: immber Date: Thu, 13 Dec 2018 13:10:14 -0800 Subject: [PATCH 16/18] added link to asset scraping --- docs/source/integrating/cms-integration.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/integrating/cms-integration.md b/docs/source/integrating/cms-integration.md index f832d15ae..521ab5cf8 100644 --- a/docs/source/integrating/cms-integration.md +++ b/docs/source/integrating/cms-integration.md @@ -70,6 +70,8 @@ sync?_ ### “Lazy Asset Creation” Talk’s provided embed script by default dynamically generates Assets in Talk based on each unique url that triggers it. The url must reference an existing Permitted Domain. If your articles/stories always have unique urls, then you will not need to modify the default behavior. +Assets created in this way will then be scraped to load metadata, see [Asset Scraping](/talk/integrating/asset-scraping/) + ## Customizing the Integration with a Plugin In order to have more strict control over the asset creation flow to allow only assets pushed into it from your CMS, and keep your URL/title in sync we will create a plugin. From 08146fd9795d0072f8195f1dfce6718f5421f32b Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 14 Dec 2018 12:04:28 -0800 Subject: [PATCH 17/18] added redirect --- docs/public/_redirects | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/public/_redirects b/docs/public/_redirects index 617eb6adc..5bb190a8b 100644 --- a/docs/public/_redirects +++ b/docs/public/_redirects @@ -1,3 +1,4 @@ / /talk/ /talk/reference/server/ /talk/api/server/ -/talk/reference/graphql/ /talk/api/graphql/ \ No newline at end of file +/talk/reference/graphql/ /talk/api/graphql/ +/talk/integrating/asset-management/ /talk/integrating/cms-integration \ No newline at end of file From c8fc419ceca31ab8027c2729ebf6c54e6ac065bb Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Fri, 14 Dec 2018 20:46:57 +0000 Subject: [PATCH 18/18] Update _redirects --- docs/public/_redirects | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/public/_redirects b/docs/public/_redirects index 5bb190a8b..df70683ab 100644 --- a/docs/public/_redirects +++ b/docs/public/_redirects @@ -1,4 +1,4 @@ / /talk/ /talk/reference/server/ /talk/api/server/ /talk/reference/graphql/ /talk/api/graphql/ -/talk/integrating/asset-management/ /talk/integrating/cms-integration \ No newline at end of file +/talk/integrating/asset-management/ /talk/integrating/cms-integration/