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);