Skip to content

Commit

Permalink
Merge pull request #4016 from coralproject/develop
Browse files Browse the repository at this point in the history
v7.1.3
  • Loading branch information
tessalt authored Aug 3, 2022
2 parents 3d5a725 + 2bda76a commit 9cd4906
Show file tree
Hide file tree
Showing 264 changed files with 6,025 additions and 17,837 deletions.
24 changes: 0 additions & 24 deletions CLIENT_EVENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@ createComment.error
- <a href="#requestAccountDeletion">requestAccountDeletion</a>
- <a href="#requestDownloadCommentHistory">requestDownloadCommentHistory</a>
- <a href="#resendEmailVerification">resendEmailVerification</a>
- <a href="#scrollCommentUpOutOfView">scrollCommentUpOutOfView</a>
- <a href="#setCommentsOrderBy">setCommentsOrderBy</a>
- <a href="#setCommentsTab">setCommentsTab</a>
- <a href="#setMainTab">setMainTab</a>
Expand Down Expand Up @@ -145,7 +144,6 @@ createComment.error
- <a href="#viewFullDiscussion">viewFullDiscussion</a>
- <a href="#viewNewComments">viewNewComments</a>
- <a href="#viewNewCommentsNetwork">viewNewCommentsNetwork</a>
- <a href="#viewNewRepliesNetwork">viewNewRepliesNetwork</a>

### Events
- <a id="approveComment">**approveComment.success**, **approveComment.error**</a>: This event is emitted when the viewer approves a comment.
Expand Down Expand Up @@ -468,12 +466,6 @@ createComment.error
};
}
```
- <a id="scrollCommentUpOutOfView">**scrollCommentUpOutOfView**</a>: This event is emitted when the viewer scrolls a comment up and out of view on the stream.
```ts
{
commentID?: string | undefined;
}
```
- <a id="setCommentsOrderBy">**setCommentsOrderBy**</a>: This event is emitted when the viewer changes the sort order of the comments.
```ts
{
Expand Down Expand Up @@ -691,20 +683,4 @@ createComment.error
};
}
```
- <a id="viewNewRepliesNetwork">**viewNewRepliesNetwork.success**, **viewNewRepliesNetwork.error**</a>: This event is emitted when the viewer reveals new live replies to comments.
```ts
{
storyID?: string | undefined;
keyboardShortcutsConfig: {
source: string;
key: string;
reverse: boolean;
} | null;
success: {};
error: {
message: string;
code?: string | undefined;
};
}
```
<!-- END docs:events -->
1 change: 0 additions & 1 deletion config/jest/client.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ module.exports = {
"^coral-test/(.*)$": "<rootDir>/src/core/client/test/$1",
},
moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node", "ftl"],
snapshotSerializers: ["enzyme-to-json/serializer"],
globals: {
"ts-jest": {
babelConfig: true,
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cms.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ See [GraphQL API Overview](/api/schema) for help with the API.

By default, stories have their metadata scraped when they are loaded. This provides the easiest way for newsrooms to integrate their CMS’s into Coral in a simple way. We use the meta tags in the table below on the target pages to allow us to extract some properties.

Metadata scraping is performed by the `scraper` job which is enabled by default. If you see story Titles in the **Stories** list as `Not available`, this likely means the story could not be scraped automatically, and the first thing to try is to try re-running the scraper job by selecting `Re-scrape` from the menu in the **Actions** column.
Metadata scraping is performed by the `scraper` job which is enabled by default. If you see story Titles in the **Stories** list as `Not available`, this likely means the story could not be scraped automatically. Try re-running the scraper job by selecting `Re-scrape` from the menu in the **Actions** column.

If your production site is behind a paywall or otherwise prevents scraping, you might need to configure a **Scraper Proxy URL**. When specified it allows scraping requests to use the provided proxy. All requests are then passed through the appropriate proxy as parsed by the npm proxy-agent package. A Scraper Proxy URL can be added in the coral Admin under "CONFIGURE" -> "Advanced" -> "Story creation".

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Yes! For version 4.x.x we have a community-supported [import framework](https://

Import tools are still in development for version 5, but will be coming soon! Contact us at [[email protected]](mailto:[email protected]) if you need an importer for version 5.x.x.

## Does Coral enforce unique usernames?

We don't do this because your [SSO](https://docs.coralproject.net/sso) should be the single source of truth for all user account management, including usernames. If Coral were to reject or change usernames supplied by the SSO, there would be a conflict, as we only receive from your SSO and don't push changes to your user database.

## What support is available?

You can always email us at [[email protected]](mailto:[email protected]), and if we are able to help we will answer your questions. In some cases, we are able to offer paid support packages. You can inquire about this via the support email address above.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ cat > docker-compose.yml <<EOF
version: "2"
services:
talk:
image: coralproject/talk:6
image: coralproject/talk:7
restart: always
ports:
- "127.0.0.1:5000:5000"
Expand Down
5 changes: 4 additions & 1 deletion docs/docs/migrating-6-to-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Coral v7 includes a major change in the technology underlying the stream embed.
- Minimum browser requirements have changed: Coral 7.0.0 will only work in browser that support the Shadow DOM API, which includes all currently supported versions of Chrome, Firefox, Safari, and Edge. Coral 7.0.0 is not compatible with Internet Explorer 11.
- Custom font declarations must now be referenced in a new "Custom CSS Stylesheet URL for Font Faces" field
- Custom CSS targeting `body`, `html` or `:root` will no longer work, as Coral no longer renders a full HTML document
- the property `bodyClassName` in the `createStreamEmbed` options has been changed to `containerClassName`
- All network requests will now originate in the main page context instead of inside the iframe, this may cause problems if you have a strict [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP). Test Coral v7 in a staging environment to be sure. You may need to whitelist Coral URLs in your Content Security Policy.

## How to update from Coral v6.18 to v7 without losing your styling
Expand Down Expand Up @@ -52,7 +53,9 @@ html {
}
```

3. If your site has a Content Security Policy that prohibits websocket (`wss://`) requests, you will need to update it to whitelist `wss://[your coral URL]/api/graphql/live` in order for live updates to function.
3. If you specify a `bodyClassName` property in the `createStreamEmbed` options, you will need to replace it with the new property `containerClassName`

4. If your site has a Content Security Policy that prohibits websocket (`wss://`) requests, you will need to update it to whitelist `wss://[your coral URL]/api/graphql/live` in order for live updates to function.

## After Coral has been updated to v7

Expand Down
Loading

0 comments on commit 9cd4906

Please sign in to comment.