Skip to content

Commit

Permalink
DOC-2230: add new How to fix invalid API key in TinyMCE page to `ti…
Browse files Browse the repository at this point in the history
…nymce/docs` project. (#3026)

* DOC-2230: add new  page to  project.

* DOC-2230: minor copy edit changes and small correction on 6.8.1 release notes page.
  • Loading branch information
kemister85 authored Dec 8, 2023
1 parent a7d31ec commit 102fd93
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 1 deletion.
1 change: 1 addition & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/

### Unreleased

- DOC-2230: add new `How to fix invalid API key in TinyMCE` page to `tinymce/docs` project.

### 2023-12-06

Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -529,4 +529,5 @@
**** xref:6.0-release-notes-premium-changes.adoc[Premium changes]
**** xref:6.0-release-notes-known-issues.adoc[Known issues]
** xref:changelog.adoc[Changelog]
* xref:invalid-api-key.adoc[Invalid API key]
* xref:support.adoc[Support]
2 changes: 1 addition & 1 deletion modules/ROOT/pages/6.8.1-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ As a consequence, the `focus` would consistently shift back to the editor, irres

{productname} 6.8.1 addresses this issue, now, the focus is only retained within the editor if the notification closure was initiated by user interaction.

=== Selecting a cell with only ` ` in a table inside a `td` and then press `backspace` the entire table is deleted
=== Selecting a cell with only `+ +` in a table inside a `td` and then press `backspace` the entire table is deleted
// #TINY-10254
Previously, the editor checked the number of tables included in a selection by identifying the closest parent to the selected elements within the table. However, when selecting part of a nested table along with some other element, two different tables were detected: the nested one and the one containing both the nested table and the additional element.

Expand Down
6 changes: 6 additions & 0 deletions modules/ROOT/pages/cloud-troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Update the `+src+` URL to include your (website or application developer's) {clo

To retrieve your API key, or to sign up for an API key, visit: link:{accountsignup}/[{cloudname}].

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}.

[[A-valid-API-key-is-required-starting-2024-to-continue-using-TinyMCE.-Please-alert-your-admin-to-check-the-current-API-key]]
== "A valid API key is required, starting 2024, to continue using TinyMCE. Please alert your admin to check the current API key."

Expand All @@ -56,6 +58,8 @@ Check the `+apiKey+` provided in the script tag:
* 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}.

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-with-Tiny-Cloud.-To-continue-using-TinyMCE-a-registered-domain-is-required-starting-2024.-Please-alert-your-admin-to-review-the-approved-domains-and-add-this-one-if-required.]]
== "This domain is not registered with Tiny Cloud. To continue using TinyMCE, a registered domain is required, starting 2024. Please alert your admin to review the approved domains and add this one if required."

Expand Down Expand Up @@ -106,3 +110,5 @@ You may also be seeing this notification if you are using the wrong API key. Ens
=== Solution

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}.
49 changes: 49 additions & 0 deletions modules/ROOT/pages/invalid-api-key.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
= Invalid API key
:description_short: Fixing with invalid API key error | {productname}
:description: Learn what you need to do when getting a message about invalid {productname} API key. Find out the reasons for this error as well as how to fix it.
:keywords: {productname}, cloud, script, textarea, apiKey, faq, invalid api key, frequently asked questions,

[IMPORTANT]
====
All editors on our cloud platform are required (from early 2024) to have a valid API key. Without a valid API key, your editor will transition to **read-only** mode, limiting your ability to make changes.
* This change will only affect users who do not have a valid API key and use Tiny Cloud.
* Affected users should see a xref:cloud-troubleshooting.adoc[notification in their editor]. If you see it, please contact the Administrator for your application/site. Admins need to https://www.tiny.cloud/my-account/integrate/[get a valid API key] and paste it into the code to continue using {productname}.
====

== How can I verify this change will affect me?

If {productname} detects an invalid API key, it will display a notification. If you know or suspect you have been actively hiding or suppressing this notification, please remove these overrides. If you then see a notification, please follow the instructions to resolve the issue. If no notification pops up, everything's fine.

== How to get your API key:

The Admin who owns this {productname} implementation needs to log in https://www.tiny.cloud/my-account/integrate/[here] to get the account’s API key. If you do not have an account yet, you can https://www.tiny.cloud/pricing/[sign up for a free API key]. If you need help, please https://www.tiny.cloud/contact/[contact our Customer Success Team].

== What will happen if I don't provide a valid API key?

All editors without valid API keys on Tiny Cloud will be set to read-only mode in the beginning of 2024. You will not be impacted if you self-host {productname}.

== Why do I need the API key?

In order to maintain the quality of our service, ensure reliable security, and keep up with industry best practices, all {productname} Cloud editors will require an active and valid API key beginning in early 2024.

== If {productname} is free and open source, why am I now getting warnings saying an API key is required?

{productname} can be accessed through a variety of licensing and hosting methods, including both free and paid options.
{productname} is available under an MIT license explained https://www.tiny.cloud/legal/tiny-self-hosted-oem-saas-agreement/[here]. Users must self-host {productname} to take advantage of the MIT license.

{productname} Cloud offerings are available under commercial license, as described https://www.tiny.cloud/legal/cloud-use-subscription-agreement/[here]. There is a free Cloud plan called “Core”, that is completely free but is limited to 1,000 editor loads per month. There are also 2 Cloud plans called “Essential” and “Professional” with increased editor load limits, and additional premium features. You can find more information on editor load limits, feature breakdowns, and pricing of our Cloud plans https://www.tiny.cloud/pricing/[here].

All of our Cloud plans require an active API key, so if you’re seeing this error message you need to either migrate to the self-hosted open source version under the MIT license, or you need to acquire an active API key by https://www.tiny.cloud/pricing/[signing up] for a cloud plan.

== I installed the npm package, which I assumed would be self-hosted. Why do I get a notification that an API key is required?

Our integrations default to using the {productname} Cloud service. If you see a notification that an API key is required, it means that you’re using Tiny Cloud service that now requires a valid API key and lets you have 1,000 editor loads per month for free.

Please xref:installation.adoc[read our docs] to learn how to self-host {productname} or https://www.tiny.cloud/pricing/[sign up here] to continue using {productname} Cloud.

== I used {productname} for years. Why am I now getting warnings saying an API key is required?

Thank you for your long-time use of {productname} and for selecting it for your projects. If you're suddenly seeing this message, it means that previous versions of this notification were hidden within your {productname} editor. We are working to ensure that all active users of {productname} are aware of this API key requirement, including those that may have hidden these warnings in the past. If action is not taken before early 2024, these editors will stop functioning.

TIP: For additional information on Troubleshooting Tiny Cloud visit: xref:cloud-troubleshooting.adoc[Cloud Troubleshooting].

0 comments on commit 102fd93

Please sign in to comment.