Skip to content

Commit

Permalink
Merge branch 'release/docs-6' into hotfix/6/DOC-2162
Browse files Browse the repository at this point in the history
  • Loading branch information
FarzadHayat authored Feb 9, 2024
2 parents 9941fff + 6f4721e commit 18e71f0
Show file tree
Hide file tree
Showing 8 changed files with 248 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .api-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.8.2
6.8.3
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This project is built using [Antora](https://antora.org/).
If you would like to contribute to the TinyMCE project please read the TinyMCE Documentation Contributor’s Guide at either:

- [TinyMCE Documentation - Contributor's Guide](https://www.tiny.cloud/docs/configure/contributing-docs/).
- [GitHub - Contributing to the TinyMCE developer documentation](https://github.com/tinymce/tinymce-docs/blob/develop/CONTRIBUTING.md#contributing-to-the-tinymce-developer-documentation).
- [GitHub - How to contribute to TinyMCE’s documentation](https://github.com/tinymce/tinymce-docs/blob/release/docs-6/CONTRIBUTING.md#how-to-contribute-to-tinymces-documentation).

## Working on TinyMCE documentation

Expand Down
14 changes: 14 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/

- DOC-2162: Improve documentation for `noneditable` options and multi-root editing.

### 2024-02-09

- DOC-2281: updates to `cloud-troubleshooting.adoc` with new `link` directs to `domain-not-registered`.

### 2024-02-08

- DOC-2242: Added 6.8.3-specific entry to `changelog.adoc`.

- DOC-2241: added `6.8.3-release-notes.adoc` to project; updated `changelog.adoc`, `nav.adoc` and `release-notes.adoc` for the TinyMCE 6.8.3 release.

### 2024-02-05

- DOC-2276: updates to `cloud-troubleshooting.adoc` with new `read-only` ref and links to `invalid-api-key.adoc` page.

### 2024-01-31

- DOC-2275: updates to `cloud-troubleshooting.adoc` with new links to `invalid-api-key.adoc` page.
Expand Down
6 changes: 6 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,12 @@
** xref:tinymce-and-cors.adoc[Cross-Origin Resource Sharing (CORS)]
* Release information
** xref:release-notes.adoc[Release notes for TinyMCE 6]
*** TinyMCE 6.8.3
**** xref:6.8.3-release-notes.adoc#overview[Overview]
**** xref:6.8.3-release-notes.adoc#accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
**** xref:6.8.3-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
**** xref:6.8.3-release-notes.adoc#bug-fixes[Bug fixes]
**** xref:6.8.3-release-notes.adoc#security-fix[Security fix]
*** TinyMCE 6.8.2
**** xref:6.8.2-release-notes.adoc#overview[Overview]
**** xref:6.8.2-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium Plugin changes]
Expand Down
134 changes: 134 additions & 0 deletions modules/ROOT/pages/6.8.3-release-notes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
= TinyMCE 6.8.3
:navtitle: TinyMCE 6.8.3
:description: Release notes for TinyMCE 6.8.3
:keywords: releasenotes, new, changes, bugfixes
:page-toclevels: 1

include::partial$misc/admon-releasenotes-for-stable.adoc[]

[[overview]]
== Overview

{productname} 6.8.3 was released for {enterpriseversion} and {cloudname} on Wednesday, February 08^th^, 2024. These release notes provide an overview of the changes for {productname} 6.8.3, including:

* xref:accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes]
* xref:accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
* xref:bug-fixes[Bug fixes]
* xref:security-fixes[Security fixes]

[[accompanying-premium-self-hosted-server-side-component-changes]]
== Accompanying Premium self-hosted server-side component changes

The {productname} 6.8.3 release includes accompanying changes affecting the {productname} **self-hosted** services for the following plugins:

* **Enhanced Media Embed** plugin `mediaembed`.
* **Export** plugin `export`.
* **Enhanced Image Editing** plugin `editimage`.
* **Link Checker** plugin `linkchecker`.
* **Spell Checker Pro** plugin `tinymcespellchecker`.
* **Spelling Autocorrect** plugin `autocorrect`.

For information on:

* The **Enhanced Media Embed** plugin, see: xref:introduction-to-mediaembed.adoc[Enhanced Media Embed plugin].
* The **Export** plugin, see: xref:export.adoc[Export plugin].
* The **Enhanced Image Editing** plugin, see: xref:editimage.adoc[Enhanced Image Editing plugin].
* The **Link Checker** plugin, see: xref:linkchecker.adoc[Link Checker plugin].
* The **Spell Checker Pro** plugin, see: xref:introduction-to-tiny-spellchecker.adoc[Spell Checker Pro plugin].
* The **Spelling Autocorrect** plugin, see: xref:autocorrect.adoc[Spelling Autocorrect plugin].
* Deploying the **server-side** components, see: xref:introduction-to-premium-selfhosted-services.adoc[Server-side component installation].

The Java server-side components have been updated to the following versions:

* `ephox-hyperlinking.war`: 2.105.24
* `ephox-image-proxy.war`: 2.106.11
* `ephox-spelling.war`: 2.118.19


=== Updating the self-hosted server-side components

The new versions of the server-side services provide updates for the Java-based server-side components. To deploy the updated version of the server-side components:

. Update your Java Application Server to the minimum required version:

include::partial$misc/supported-application-servers.adoc[]

. Replace the existing server-side `.war` files with the `.war` files bundled with {productname} 6.8.3 or later.

For information on:

* Deploying the server-side components, see: xref:introduction-to-premium-selfhosted-services.adoc[Server-side component installation].
* Deploying the server-side components using Docker, see: xref:bundle-intro-setup.adoc[Containerized service deployments].

include::partial$misc/admon-no-functionality-changes-in-updated-server-side-components.adoc[]


[[accompanying-premium-plugin-changes]]
== Accompanying Premium plugin changes

The following premium plugin updates were released alongside {productname} 6.8.3.

=== PowerPaste 6.2.5

The {productname} 6.8.3 release includes an accompanying release of the **PowerPaste** premium plugin.

**PowerPaste** 6.2.5 includes the following fix.

==== PowerPaste would sometimes consider a shape or a picture to be an equation when it is not.
//#TINY-10449

In previous versions of **PowerPaste**, users encountered an issue while copying/pasting content from a Microsoft Word document when **PowerPaste** Plugin was enabled in the editors configuration.

As a consequence, if the copied content contained images and equations, the images would not appear in the expected locations on paste.

**PowerPaste** 6.2.5 addresses this issue, by enhancing the image and equation detection logic.

As a result, images now appear in their correct locations as expected.

[NOTE]
The current version of **PowerPaste** does not currently support equations within {productname}.

For information on the **PowerPaste** plugin, see: xref:introduction-to-powerpaste.adoc[PowerPaste].


[[bug-fixes]]
== Bug fixes

{productname} 6.8.3 also includes the following bug fixes:

=== `ShadowDOM` skin was not loaded properly when used with js bundling feature.
//#TINY-10451

When using the js bundling feature with the `ShadowDom` skin, the editor would not load the skin properly.

As a consequence, any editor bundled with this specific setup would result in the editor loading without displaying the toolbar.

{productname} 6.8.3 addresses this issue, now, during the loading process the `ShadowDOM` skin is correctly used when using the js bundling feature.

As a result, the editor loads properly and the toolbar appears as expected.

=== The floating toolbar would not be fully visible when the editor was placed inside a scrollable container.
//#TINY-10335

Previously, when the editor was configured to be set within a scrollable container, and the `ui_mode: 'split'` is set, the floating toolbar was obscured when the user switched to fullscreen.

As a consequence, the floating toolbar UI was not completely visible when switching to fullscreen.

{productname} 6.8.3 addresses this, now, when the container containing the editor UI elements are set to a `fixed` css position when the editor is switched to fullscreen.

As a result, the toolbar is now no longer obscured when switching to fullscreen.

[[security-fixes]]
== Security fixes

{productname} 6.8.3 includes one fix for the following security issue:

The following server-side component has been updated to include dependency updates addressing the following security issues.

* https://nvd.nist.gov/vuln/detail/CVE-2023-6378[CVE-2023-6378]

This update is considered as a High severity vulnerability fix.

For information on the server-side components updates, see: xref:#accompanying-premium-self-hosted-server-side-component-changes[Accompanying Premium self-hosted server-side component changes].

include::partial$misc/admon-no-functionality-changes-in-updated-server-side-components.adoc[]
9 changes: 9 additions & 0 deletions modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].

== 6.8.3 - 2024-02-08

=== Changed
* Update outbound TinyMCE website links.

=== Fixed
* `ShadowDOM` skin was not loaded properly when used with JS bundling feature.
* The floating toolbar would not be fully visible when the editor was placed inside a scrollable container.

== 6.8.2 - 2023-12-11

=== Fixed
Expand Down
105 changes: 77 additions & 28 deletions modules/ROOT/pages/cloud-troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ When {cloudname} detects a problem, it will show an editor notification containi

NOTE: The wording of the notifications shown here may differ from the actual notifications from {cloudname}.

[[A-valid-API-key-is-required-to-continue-using-TinyMCE.-Please-alert-the-admin-to-check-the-current-API-key]]
== "A valid API key is required to continue using {productname}. **Please alert the admin** to check the current API key. xref:invalid-api-key.adoc[Click here to learn more.]"
'''

=== Scenario (one)
[[invalid-api-key-cloud-troubleshooting]]
== Invalid API Key

==== Cause
[[A-valid-API-key-is-required-to-continue-using-TinyMCE.-Please-alert-the-admin-to-check-the-current-API-key]]
=== "A valid API key is required to continue using {productname}. **Please alert the admin** to check the current API key. xref:invalid-api-key.adoc[Click here to learn more.]"

==== Cause "No API Key"

This notification is *only shown* when either:

Expand Down Expand Up @@ -41,9 +44,7 @@ To retrieve your API key, or to sign up for an API key, visit: link:{accountsign

NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.

=== Scenario (two)

==== Cause
==== Cause "Invalid API Key"

This notification is shown when the API key provided cannot be found on the {cloudname} server.

Expand All @@ -55,31 +56,32 @@ The `+apiKey+` must be:

==== Solution

Check the `+apiKey+` provided in the script tag:
Check the `apiKey` provided in the script tag:

* Remove any leading or trailing spaces.
* Any other characters that are not in your API key. If you are using variable substitution, ensure that the variable is substituting properly.
* Matches the API key shown at {accountpageurl}.
* Remove any leading or trailing spaces
* Remove any other characters that are not in your `apiKey`. If you are using variable substitution, ensure that the variable is substituting properly
* Ensure the `apiKey` matches the API key shown at {accountpageurl}.

NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.

'''

[[This-domain-is-not-registered-in-the-TinyMCE-Customer-Portal.-Please-alert-the-admin-to-add-it-to-the-approved-domains-to-continue-using-TinyMCE.]]
== "This domain is not registered in the {productname} Customer Portal. **Please alert the admin** to add it to the approved domains to continue using {productname}. xref:invalid-api-key.adoc[Click here to learn more.]"
[[domain-not-registered]]
== Domain Not Registered

=== Scenario
[[This-domain-is-not-registered-in-the-TinyMCE-Customer-Portal.-Please-alert-the-admin-to-add-it-to-the-approved-domains-to-continue-using-TinyMCE.]]
=== "This domain is not registered in the {productname} Customer Portal. **Please alert the admin** to add it to the approved domains to continue using {productname}. xref:invalid-api-key.adoc[Click here to learn more.]"

==== Cause

This notification is shown when the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer[*Referer*] of the page does not match the list of approved domains stored against your `+apiKey+`. {cloudname} verifies the domain {productname} is loading from by checking the domain portion of the *Referer* header in the network request. You can view a list of your approved domains on your link:{accountpageurl}/[{accountpage}].

Sometimes the domain in the *Referer* header does not match with the URL in the browser's address bar. To check the *Referer* header:

. Open your browser's _Developer's Tools_.
. Open the _Network_ tab.
. Find and select the request being made to load {productname} from {cloudname} with your API key.
. Click on the *Headers* tab.
* Open your browser's _Developer's Tools_.
* Open the _Network_ tab.
* Find and select the request being made to load {productname} from {cloudname} with your API key.
* Click on the *Headers* tab.

In the section called *Request Headers* there should be a field for *Referer*. This is the value that {productname} is checking against your approved domains. It must match one of your approved domains listed on your link:{accountpageurl}/[{accountpage}].

Expand All @@ -89,16 +91,16 @@ If the `+Referer+` is correct for the site, ensure that the domain is included i

'''

[[were-unable-to-check-your-domain-because-the-referer-header-is-missing-please-read-the-guide-on-how-to-ensure-your-referer-header-is-present-so-we-can-then-customize-your-editor-experience]]
== "We’re unable to check your domain because the referer header is missing. Please read the Guide on how to ensure your referer header is present, so we can then customize your editor experience."
[[referer-heading-missing]]
== Referer Heading Missing

=== Scenario
[[were-unable-to-check-your-domain-because-the-referer-header-is-missing-please-read-the-guide-on-how-to-ensure-your-referer-header-is-present-so-we-can-then-customize-your-editor-experience]]
=== "We’re unable to check your domain because the referer header is missing. Please read the Guide on how to ensure your referer header is present, so we can then customize your editor experience."

==== Cause

This notification is shown if the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer[*Referer* header] is absent for the network request when loading {productname} from {cloudname}. {cloudname} verifies the domain {productname} is loading from by checking the domain of the *Referer* header in the network request.

_Referer_ headers are sometimes removed by browser settings or browser extensions. {cloudname} only needs the domain in the *Referer* header, so for improved performance and privacy {companyname} recommends setting the `+referrerpolicy+` to `+origin+` when requesting {cloudname} resources.
* This notification is shown if the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer[*Referer* header] is absent for the network request when loading {productname} from {cloudname}. {cloudname} verifies the domain {productname} is loading from by checking the domain of the *Referer* header in the network request.
* _Referer_ headers are sometimes removed by browser settings or browser extensions. {cloudname} only needs the domain in the *Referer* header, so for improved performance and privacy {companyname} recommends setting the `+referrerpolicy+` to `+origin+` when requesting {cloudname} resources.

==== Solution

Expand All @@ -111,10 +113,11 @@ Once you have identified the setting or extension, modify it to allow just the `

'''

[[the-___-premium-plugin-is-not-enabled-on-your-api-key-upgrade-your-account]]
== "The ___ premium plugin is not enabled on your API key. Upgrade your account."
[[troubleshooting-premium-plugins]]
== Troubleshooting Premium Plugins

=== Scenario
[[the-___-premium-plugin-is-not-enabled-on-your-api-key-upgrade-your-account]]
=== "The ___ premium plugin is not enabled on your API key. Upgrade your account."

==== Cause

Expand All @@ -126,4 +129,50 @@ You may also be seeing this notification if you are using the wrong API key. Ens

Either remove the premium plugin from your {productname} configuration, or upgrade your subscription to provide access to that premium plugin.

NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.
NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.

'''

[[read-only-mode-no-api-key]]
== Read-only mode - No API Key

=== “{productname} is in read-only mode. **Please alert the admin** that an API key is required for continued use. xref:invalid-api-key.adoc[Learn more]

==== Cause "No API Key (Read only mode)"

This message is sent when the developer has not supplied an API key, typically because they've copied a getting-started script and have not completed the official https://www.tiny.cloud/auth/signup/[signup] process to get an API key.

==== Solution

* **Please alert your Admin** that an API key is required for continued use. xref:invalid-api-key.adoc[Learn more], or
* Sign up for a API key by visiting https://www.tiny.cloud/auth/signup/[www.tiny.cloud/auth/signup], and
* Update your {productname} configuration.

NOTE: Visit our xref:invalid-api-key.adoc[Invalid API key] page for more information on how to fix a `invalid API key` with {productname}.

[[read-only-mode-invalid-api-key]]
== Read-only mode - Invalid API Key

=== “{productname} is in read-only mode. **Please alert the admin** to provide a valid API key to continue use. xref:invalid-api-key.adoc[Learn more] Your {productname} editor state has been set to read-only mode.”

==== Cause "Invalid API Key (Read only-mode)"

This message is shown when the API key is not correct, perhaps because of a typo.

==== Solution

* Login to your {productname} account and confirm that your API key matches your unique key by visiting https://www.tiny.cloud/auth/login/[www.tiny.cloud/auth/login/].
* or to sign up for an API key, visit: link:{accountsignup}/[{cloudname}].

[[read-only-mode-invalid-origin]]
== Read-only mode - Invalid Origin

=== “{productname} is in read-only mode. **Please request that the admin** add this domain to the approved domains in the Customer Portal. For more information see xref:cloud-troubleshooting.adoc#domain-not-registered[Domain not registered]”

==== Cause "Invalid Origin (Read only mode)"

This message is shown when {productname} is loaded from a domain that has not been added to the approved domains in our account portal.

==== Solution

Please request that your admin add this domain to the approved domains in the Customer Portal. For more information see xref:cloud-troubleshooting.adoc#domain-not-registered[Domain not registered]
6 changes: 6 additions & 0 deletions modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This section lists the releases for {productname} 6 and the changes made in each
[cols="1,1"]
|===

a|
[.lead]
xref:6.8.3-release-notes.adoc#overview[{productname} 6.8.3]

Release notes for {productname} 6.8.3

a|
[.lead]
xref:6.8.2-release-notes.adoc#overview[{productname} 6.8.2]
Expand Down

0 comments on commit 18e71f0

Please sign in to comment.