From e278ea3cc97967e555757a54216d788890f80dd2 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 10 Feb 2025 16:09:30 +1000 Subject: [PATCH 1/4] Update key documentation pages with information about the Cloud account creation and the social login option. --- modules/ROOT/pages/cloud-quick-start.adoc | 2 + modules/ROOT/pages/invalid-api-key.adoc | 3 + modules/ROOT/pages/usage-based-billing.adoc | 8 +- ...on-account-creation-and-social-option.adoc | 76 +++++++++++++++++++ modules/ROOT/partials/what-is-tinymce.adoc | 4 + 5 files changed, 91 insertions(+), 2 deletions(-) create mode 100644 modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc diff --git a/modules/ROOT/pages/cloud-quick-start.adoc b/modules/ROOT/pages/cloud-quick-start.adoc index 689819c54d..7be7d76e6e 100644 --- a/modules/ROOT/pages/cloud-quick-start.adoc +++ b/modules/ROOT/pages/cloud-quick-start.adoc @@ -6,3 +6,5 @@ :productSource: cloud include::partial$install/basic-quickstart-base.adoc[] + +include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/invalid-api-key.adoc b/modules/ROOT/pages/invalid-api-key.adoc index 97bab0c5b1..3f57fa1a69 100644 --- a/modules/ROOT/pages/invalid-api-key.adoc +++ b/modules/ROOT/pages/invalid-api-key.adoc @@ -11,6 +11,9 @@ Affected users will receive a xref:cloud-troubleshooting.adoc#A-valid-API-key-is-required-starting-2024-to-continue-using-TinyMCE.-Please-alert-your-admin-to-sign-up-to-get-your-free-API-key.[notification in their editor]. If you receive this notification, please contact the Administrator for your application/site. Admins will need to https://www.tiny.cloud/my-account/integrate/[get a valid API key] and paste it into the code to continue using {productname}. ==== + +include::partial$misc/admon-account-creation-and-social-option.adoc[] + == How will I know if this change affects 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 appears, you are not affected. diff --git a/modules/ROOT/pages/usage-based-billing.adoc b/modules/ROOT/pages/usage-based-billing.adoc index f26a7fe227..1fb12a1515 100644 --- a/modules/ROOT/pages/usage-based-billing.adoc +++ b/modules/ROOT/pages/usage-based-billing.adoc @@ -6,7 +6,9 @@ [NOTE] -The below information is only relevant to Tiny Cloud users. Users who self-host the open source version of {productname} are not subject to Usage-Based Billing terms, but are required to comply with the open source license terms. +The below information is only relevant to Tiny Cloud users. Users who self-host the open source version of {productname} are not subject to Usage-Based Billing terms, but are required to comply with the open source license terms. + +include::partial$misc/admon-account-creation-and-social-option.adoc[] == Definitions @@ -67,4 +69,6 @@ If you have an annual plan, your editor loads are calculated on a monthly basis === If I’m on the Essential plan and reach 5,000 editor loads, will I automatically be upgraded to the Professional plan? -You will not automatically be upgraded. You will remain on your current plan and will automatically be charged $40 USD for each additional block of 1,000 editor loads over your plan limit. To avoid these charges, we encourage you to periodically review your editor load count to ensure you’re on the most appropriate pricing plan. You can always upgrade your plan in our Customer Portal > Settings > Billing Portal > Change Plans. \ No newline at end of file +You will not automatically be upgraded. You will remain on your current plan and will automatically be charged $40 USD for each additional block of 1,000 editor loads over your plan limit. To avoid these charges, we encourage you to periodically review your editor load count to ensure you’re on the most appropriate pricing plan. You can always upgrade your plan in our Customer Portal > Settings > Billing Portal > Change Plans. + +include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file diff --git a/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc b/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc new file mode 100644 index 0000000000..3a75d5603f --- /dev/null +++ b/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc @@ -0,0 +1,76 @@ +++++ +
+

+ It only takes 2 minutes to create your free Tiny account and get the API key: +

+ +
+ +++++ \ No newline at end of file diff --git a/modules/ROOT/partials/what-is-tinymce.adoc b/modules/ROOT/partials/what-is-tinymce.adoc index 009ac8c3c8..270656c575 100644 --- a/modules/ROOT/partials/what-is-tinymce.adoc +++ b/modules/ROOT/partials/what-is-tinymce.adoc @@ -1,5 +1,7 @@ {productname} is a rich-text editor that allows users to create formatted content within a user-friendly interface. +include::partial$misc/admon-account-creation-and-social-option.adoc[] + liveDemo::default-editor[] The output created is in HTML5 and can include lists, tables, and other useful elements, depending on your configuration. The functionality of the editor can be extended through plugins and customizations, or limited to suit your use-case. {productname} can also be customized to look and feel like part of your application or webpage by customizing the user interface. {productname} can be integrated into a range of frameworks and Content Management Systems (CMSs), and can be either: @@ -7,3 +9,5 @@ The output created is in HTML5 and can include lists, tables, and other useful e * Loaded from the {cloudname} CDN (Content Delivery Network), which will ensure {productname} is always using the latest version. * Installed with a package manager (self-hosted). * Extracted from a .zip file (self-hosted). + +include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file From 9c3fee200193df456ccc879fa54b0870ee77eabc Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 11 Feb 2025 09:54:04 +1000 Subject: [PATCH 2/4] Updated code snippet, created partial for reuse, updated positioning. --- modules/ROOT/pages/getting-started.adoc | 6 +++- modules/ROOT/pages/invalid-api-key.adoc | 5 +++ modules/ROOT/pages/usage-based-billing.adoc | 2 ++ .../install/basic-quickstart-base.adoc | 2 ++ ...on-account-creation-and-social-option.adoc | 35 +++++++++++-------- .../admon-getting-started-with-tinymce.adoc | 4 +++ modules/ROOT/partials/what-is-tinymce.adoc | 2 ++ 7 files changed, 41 insertions(+), 15 deletions(-) create mode 100644 modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index c9d25d09e4..b2e35f2f86 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -23,4 +23,8 @@ Learn how to install {productname} via {cloudname}, package managers, self-hoste // Empty cell to even out rows // | -|=== \ No newline at end of file +|=== + +include::partial$misc/admon-getting-started-with-tinymce.adoc[] + +include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/invalid-api-key.adoc b/modules/ROOT/pages/invalid-api-key.adoc index 3f57fa1a69..949ba08f80 100644 --- a/modules/ROOT/pages/invalid-api-key.adoc +++ b/modules/ROOT/pages/invalid-api-key.adoc @@ -68,3 +68,8 @@ You can view the list of approved domains by logging into https://www.tiny.cloud * If you want to self-host {productname} and use our Premium features, https://www.tiny.cloud/contact/[get in touch with our Sales team] for a custom quote. TIP: For additional information on Troubleshooting Tiny Cloud visit: xref:cloud-troubleshooting.adoc[Cloud Troubleshooting]. + + +include::partial$misc/admon-getting-started-with-tinymce.adoc[] + +include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/usage-based-billing.adoc b/modules/ROOT/pages/usage-based-billing.adoc index 1fb12a1515..1558bef819 100644 --- a/modules/ROOT/pages/usage-based-billing.adoc +++ b/modules/ROOT/pages/usage-based-billing.adoc @@ -71,4 +71,6 @@ If you have an annual plan, your editor loads are calculated on a monthly basis You will not automatically be upgraded. You will remain on your current plan and will automatically be charged $40 USD for each additional block of 1,000 editor loads over your plan limit. To avoid these charges, we encourage you to periodically review your editor load count to ensure you’re on the most appropriate pricing plan. You can always upgrade your plan in our Customer Portal > Settings > Billing Portal > Change Plans. +include::partial$misc/admon-getting-started-with-tinymce.adoc[] + include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file diff --git a/modules/ROOT/partials/install/basic-quickstart-base.adoc b/modules/ROOT/partials/install/basic-quickstart-base.adoc index c17075db6d..4138ee9009 100644 --- a/modules/ROOT/partials/install/basic-quickstart-base.adoc +++ b/modules/ROOT/partials/install/basic-quickstart-base.adoc @@ -34,6 +34,8 @@ endif::[] {productname} {productmajorversion} is a powerful and flexible rich text editor that can be embedded in web applications. This quick start covers how to add a {productname} editor to a web page using {sourcename}. +include::partial$misc/admon-account-creation-and-social-option.adoc[] + ifeval::["{productSource}" == "composer"] To add {productname} to a PHP project using Composer, run the following on a command line: diff --git a/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc b/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc index 3a75d5603f..273aaa1539 100644 --- a/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc +++ b/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc @@ -3,9 +3,9 @@

It only takes 2 minutes to create your free Tiny account and get the API key:

- + ++++ \ No newline at end of file diff --git a/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc b/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc new file mode 100644 index 0000000000..4b4f73bebe --- /dev/null +++ b/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc @@ -0,0 +1,4 @@ +== Getting Started with {productname} + +{productname} is a powerful, flexible rich text editor for web applications. This quick-start guide explains how to integrate {productname} into a web page with {companyname} Cloud. +Install {productname} to add a feature-rich, sleek, and intuitive editor to your app with just a few lines of code. After registering, you'll receive a personalized code snippet with your API key and a guide to help you integrate {productname}. \ No newline at end of file diff --git a/modules/ROOT/partials/what-is-tinymce.adoc b/modules/ROOT/partials/what-is-tinymce.adoc index 270656c575..d83a39e868 100644 --- a/modules/ROOT/partials/what-is-tinymce.adoc +++ b/modules/ROOT/partials/what-is-tinymce.adoc @@ -10,4 +10,6 @@ The output created is in HTML5 and can include lists, tables, and other useful e * Installed with a package manager (self-hosted). * Extracted from a .zip file (self-hosted). +include::partial$misc/admon-getting-started-with-tinymce.adoc[] + include::partial$misc/admon-account-creation-and-social-option.adoc[] \ No newline at end of file From 590719e3e8387b0dc83c2afc03f4f9c1206f50a8 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Wed, 12 Feb 2025 09:05:32 +1000 Subject: [PATCH 3/4] Update modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc --- .../ROOT/partials/misc/admon-getting-started-with-tinymce.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc b/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc index 4b4f73bebe..819f5f9652 100644 --- a/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc +++ b/modules/ROOT/partials/misc/admon-getting-started-with-tinymce.adoc @@ -1,4 +1,3 @@ == Getting Started with {productname} -{productname} is a powerful, flexible rich text editor for web applications. This quick-start guide explains how to integrate {productname} into a web page with {companyname} Cloud. -Install {productname} to add a feature-rich, sleek, and intuitive editor to your app with just a few lines of code. After registering, you'll receive a personalized code snippet with your API key and a guide to help you integrate {productname}. \ No newline at end of file +{productname} is a rich text editor designed for web applications. To install {productname}, include the required script and initialize the editor with a minimal configuration. Upon registration, an API key is provided along with a corresponding code snippet for integration. \ No newline at end of file From 4f0feb077e975f6bab6fd165f8c0026bd80efa18 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 17 Feb 2025 10:29:49 +1000 Subject: [PATCH 4/4] Update modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc Co-authored-by: tiny-ben-tran --- .../misc/admon-account-creation-and-social-option.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc b/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc index 273aaa1539..640baec7ea 100644 --- a/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc +++ b/modules/ROOT/partials/misc/admon-account-creation-and-social-option.adoc @@ -5,7 +5,8 @@