Skip to content

Commit 99926c3

Browse files
committed
DOC-3151: coipy edits, and changes.
1 parent a255ec9 commit 99926c3

File tree

2 files changed

+22
-29
lines changed

2 files changed

+22
-29
lines changed

modules/ROOT/pages/cloud-troubleshooting.adoc

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,12 @@ NOTE: The wording of the notifications shown here may differ from the actual not
1515
[[A-valid-API-key-is-required-to-continue-using-TinyMCE.-Please-alert-the-admin-to-check-the-current-API-key]]
1616
=== "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.]"
1717

18-
==== Cause "no-api-key"
18+
==== Cause
1919

2020
This notification is *only shown* when either:
2121

22-
23-
image:onboarding/onboarding-no-api-key-notification.png[no-api-key-notificaiton-banner, width=800, height=auto]
24-
25-
* An `+apiKey+` is not provided in the script tag, or when `+no-api-key+` is provided as the API key.
22+
. An `+apiKey+` is not provided in the script tag.
23+
. An empty `+apiKey+`.
2624

2725
For example:
2826

@@ -31,8 +29,6 @@ For example:
3129
<script src="{cdnurl}" referrerpolicy="origin"></script>
3230
----
3331

34-
In this case, the editor will be in a **read-only** state, and the user will see a **"Finish setting up"** dialog prompting them to add a valid API key, configure their domain, and explore premium features.
35-
3632
==== Solution
3733

3834
Update the `+src+` URL to include your (website or application developer's) {cloudname} API Key. Your API key should replace the string `+no-api-key+`.
@@ -48,6 +44,11 @@ To retrieve your API key, or to sign up for an API key, visit: link:{accountsign
4844

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

47+
In this case, the editor will be in a **read-only** state, and the user will see a **"Finish setting up"** dialog prompting them to add a valid API key, configure their domain, and explore premium features.
48+
49+
[[placeholder]]
50+
=== "placeholder[Click here to learn more.]"
51+
5152
==== Cause "Invalid API Key"
5253

5354
This notification is shown when the API key provided cannot be found on the {cloudname} server.
@@ -68,32 +69,30 @@ Check the `apiKey` provided in the script tag:
6869

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

71-
'''
72-
73-
74-
[[empty-api-key]]
75-
== Empty API Key
72+
[[no-api-key-cloud-troubleshooting]]
73+
== No API Key
7674

77-
=== "A valid API key is required to continue using {productname}. Please alert the admin to check the current API key."
75+
[[A-valid-API-key-is-required-to-continue-using-TinyMCE.]]
76+
=== "A valid API key is required to continue using TinyMCE.[]"
7877

7978
==== Cause
8079

81-
This message appears if the API key portion of the `+<script>+` URL is empty, such as:
80+
When `+no-api-key+` is set as the `+apiKey+` the editor will be in a **read-only** state, and the user will see a **"Finish setting up"** dialog prompting them to add a valid API key, configure their domain, and explore premium features.
8281

82+
image:onboarding/onboarding-finish-setting-up-dialog.png[onboarding finish setting up dialog, width=500, height=auto]
8383

84-
image:onboarding/onboarding-no-api-key-notification.png[no-api-key-notificaiton-banner, width=800, height=auto]
84+
==== Solution
8585

86+
Update the `+src+` URL to include your (website or application developer's) {cloudname} API Key. Your API key should replace the string `+no-api-key+`.
8687

87-
[source,html]
88+
For example: if your API is `+abcd1234+`:
89+
90+
[source,html,subs="attributes+"]
8891
----
89-
<script src="https://cdn.staging.tiny.cloud/1//tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin"></script>
92+
<script src="https://cdn.tiny.cloud/1/abcd1234/tinymce/{productmajorversion}/tinymce.min.js" referrerpolicy="origin"></script>
9093
----
9194

92-
In this case, the resolved API key is effectively empty, resulting in a `read-only` editor state and the "A valid API key is required to continue using TinyMCE. Please alert the admin to check the current API key. Click here to learn more." message.
93-
94-
==== Solution
95-
96-
Ensure the API key is correctly included in the `+<script>+` URL, without any missing or empty segments.
95+
To retrieve your API key, or to sign up for an API key, visit: link:{accountsignup}/[{cloudname}].
9796

9897
''''
9998

modules/ROOT/partials/configuration/onboarding.adoc

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,4 @@ tinymce.init({
1818
selector: "textarea", // change this value according to your HTML
1919
onboarding: false
2020
});
21-
----
22-
23-
24-
25-
image:onboarding/onboarding-finish-setting-up-dialog.png[onboarding finish setting up dialog, width=500, height=auto]
26-
27-
image::onboarding/onboarding-trial-explore-features.png[trial-explore-features-notification-banner, width=400, height=auto]
21+
----

0 commit comments

Comments
 (0)