From 51af4ffae8ad848bcda73f0c896460972d76a9ee Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 1 Apr 2025 15:05:47 +1000 Subject: [PATCH 1/5] DOC-3189: Refactor promotion documentation and update references to new promotions page. --- modules/ROOT/nav.adoc | 2 +- modules/ROOT/pages/initial-configuration.adoc | 2 +- ...upgrade-promotion.adoc => promotions.adoc} | 2 +- .../partials/configuration/onboarding.adoc | 22 +++++++++++++++++++ .../partials/configuration/promotion.adoc | 4 ++-- .../premium-upgrade-promotion-option.adoc | 8 ++++--- 6 files changed, 32 insertions(+), 8 deletions(-) rename modules/ROOT/pages/{editor-premium-upgrade-promotion.adoc => promotions.adoc} (97%) create mode 100644 modules/ROOT/partials/configuration/onboarding.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 7766e181be..24c52f925a 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -239,7 +239,7 @@ ** xref:editor-important-options.adoc[Integration options] ** xref:editor-size-options.adoc[Size] ** xref:editor-save-and-submit.adoc[Save and submit] -** xref:editor-premium-upgrade-promotion.adoc[Premium upgrade promotion] +** xref:promotions.adoc[Promotions] * Interface ** Editor modes *** xref:use-tinymce-classic.adoc[Classic editing mode] diff --git a/modules/ROOT/pages/initial-configuration.adoc b/modules/ROOT/pages/initial-configuration.adoc index acb77246f8..ee09416a28 100644 --- a/modules/ROOT/pages/initial-configuration.adoc +++ b/modules/ROOT/pages/initial-configuration.adoc @@ -29,7 +29,7 @@ Editor options related to saving or submitting editor content. | [.lead] -xref:editor-premium-upgrade-promotion.adoc[Premium upgrade promotion] +xref:promotions.adoc[Promotions] Editor options related to turning the Premium promotion display off. diff --git a/modules/ROOT/pages/editor-premium-upgrade-promotion.adoc b/modules/ROOT/pages/promotions.adoc similarity index 97% rename from modules/ROOT/pages/editor-premium-upgrade-promotion.adoc rename to modules/ROOT/pages/promotions.adoc index 866df90217..49bb3dfe5f 100644 --- a/modules/ROOT/pages/editor-premium-upgrade-promotion.adoc +++ b/modules/ROOT/pages/promotions.adoc @@ -6,7 +6,7 @@ include::partial$misc/premium-upgrade-promotion-option.adoc[] [[premium-upgrade-promotion-defaults]] -=== Premium upgrade promotion defaults +== Premium upgrade promotion defaults When the Community distribution of {productname} 6.2 is running as a self-hosted instance, an *Upgrade* promotion button appears in the unused corner of the editor menu bar by default. The button does not appear when Community distributions of {productname} are running on the {cloudname}. diff --git a/modules/ROOT/partials/configuration/onboarding.adoc b/modules/ROOT/partials/configuration/onboarding.adoc new file mode 100644 index 0000000000..8fbffb89d1 --- /dev/null +++ b/modules/ROOT/partials/configuration/onboarding.adoc @@ -0,0 +1,22 @@ +[[onboarding]] +== `+onboarding+` + +The cloud version of {productname} contains a promotion for paid features included in the 14-day trial. This promotion can be toggled on or off with the onboarding option. + +The promotion will automatically disappear when the trial ends. + +*Type:* `+Boolean+` + +*Default value:* `+true+` for cloud instances; otherwise `+false+`. + +*Possible values:* `+true+`, `+false+` + +=== Example: using cloud `+onboarding+` + +[source,js] +---- +tinymce.init({ + selector: "textarea", // change this value according to your HTML + onboarding: false +}); +---- diff --git a/modules/ROOT/partials/configuration/promotion.adoc b/modules/ROOT/partials/configuration/promotion.adoc index d1e54e82a4..f2f0cf1300 100644 --- a/modules/ROOT/partials/configuration/promotion.adoc +++ b/modules/ROOT/partials/configuration/promotion.adoc @@ -9,9 +9,9 @@ *Possible values:* `+true+`, `+false+` -See xref:editor-premium-upgrade-promotion.adoc#premium-upgrade-promotion-defaults[Premium upgrade promotion defaults] for details. +See xref:promotions.adoc#premium-upgrade-promotion-defaults[Premium upgrade promotion defaults] for details. -=== Example: using `+promotion+` +=== Example: using open source `+promotion+` [source,js] ---- diff --git a/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc b/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc index fff022bc2d..6c88806be9 100644 --- a/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc +++ b/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc @@ -1,4 +1,6 @@ -[[premium-upgrade-promotion-option]] -== Premium upgrade promotion option +[[options]] +== Options -include::partial$configuration/promotion.adoc[leveloffset=+1] \ No newline at end of file +include::partial$configuration/promotion.adoc[leveloffset=+1] + +include::partial$configuration/onboarding.adoc[leveloffset=+1] \ No newline at end of file From 7132cba38466732de138927e4da9147d31700769 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Wed, 2 Apr 2025 08:58:39 +1000 Subject: [PATCH 2/5] DOC-3190: Update promotion documentation to clarify options for open source and cloud versions. --- modules/ROOT/pages/promotions.adoc | 21 ------------------- .../partials/configuration/onboarding.adoc | 4 +++- .../partials/configuration/promotion.adoc | 12 ++++------- 3 files changed, 7 insertions(+), 30 deletions(-) diff --git a/modules/ROOT/pages/promotions.adoc b/modules/ROOT/pages/promotions.adoc index 49bb3dfe5f..0ff73b2229 100644 --- a/modules/ROOT/pages/promotions.adoc +++ b/modules/ROOT/pages/promotions.adoc @@ -4,24 +4,3 @@ :keywords: upgrade, promotion, premium, button, lightning bolt include::partial$misc/premium-upgrade-promotion-option.adoc[] - -[[premium-upgrade-promotion-defaults]] -== Premium upgrade promotion defaults - -When the Community distribution of {productname} 6.2 is running as a self-hosted instance, an *Upgrade* promotion button appears in the unused corner of the editor menu bar by default. The button does not appear when Community distributions of {productname} are running on the {cloudname}. - -This promotion button redirects to a link:{companyurl}/tinymce-self-hosted-premium-features/[promotion page], showcasing the benefits of the variety of xref:plugins.adoc#premium-plugins[Premium Plugins] available for {productname}. - -When {productname} 6.2 or later is running as part of a Premium plan, the *Upgrade* promotion button is disabled. And it is disabled when running with a Premium plan whether {productname} is running in the {cloudname} or as a self-hosted instance. - -The {productname} Community distribution displays the promotion button when running as a self-hosted instance because the `promotion` option is set to `true` by default. To turn this button off in the Community distribution, set the `promotion` option to `false`. - -[source,js] ----- -tinymce.init({ - selector: "textarea", // change this value according to your HTML - promotion: false -}); ----- - -IMPORTANT: It is not necessary to set `promotion` to `false` when {productname} is running as part of a Premium plan. Running {productname} as part of a Premium plan automatically disables the *Upgrade* promotion button. diff --git a/modules/ROOT/partials/configuration/onboarding.adoc b/modules/ROOT/partials/configuration/onboarding.adoc index 8fbffb89d1..5129909245 100644 --- a/modules/ROOT/partials/configuration/onboarding.adoc +++ b/modules/ROOT/partials/configuration/onboarding.adoc @@ -1,7 +1,9 @@ += Open source promotion + [[onboarding]] == `+onboarding+` -The cloud version of {productname} contains a promotion for paid features included in the 14-day trial. This promotion can be toggled on or off with the onboarding option. +The cloud version of {productname} contains a promotion for paid features included in the 14-day trial. This promotion can be toggled on or off with the `+onboarding+` option. The promotion will automatically disappear when the trial ends. diff --git a/modules/ROOT/partials/configuration/promotion.adoc b/modules/ROOT/partials/configuration/promotion.adoc index f2f0cf1300..fea18861f3 100644 --- a/modules/ROOT/partials/configuration/promotion.adoc +++ b/modules/ROOT/partials/configuration/promotion.adoc @@ -1,7 +1,9 @@ += Cloud promotion + [[promotion]] == `+promotion+` -{productname} 6.2 and later includes the `promotion` option. It controls the presentation or otherwise of a Tiny-specific promotion button. +The open source version of {productname} contains a promotion for paid features. This promotion can be toggled on or off with the `+promotion+` option. *Type:* `+Boolean+` @@ -9,8 +11,6 @@ *Possible values:* `+true+`, `+false+` -See xref:promotions.adoc#premium-upgrade-promotion-defaults[Premium upgrade promotion defaults] for details. - === Example: using open source `+promotion+` [source,js] @@ -19,8 +19,4 @@ tinymce.init({ selector: "textarea", // change this value according to your HTML promotion: true }); ----- - -The *Upgrade* promotion appears in the unused corner of the {productname} menu bar. Consequently it does not appear if the menu bar is disabled. - -NOTE: The distribution-specific defaults are not fixed. Someone running {productname} as part of a Premium plan can turn this option on. And someone running the Community distribution of {productname} as a self-hosted instance can turn this option off. +---- \ No newline at end of file From 2c9ff805fa1ad4e5a00674c2fa77c76553afd58a Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 8 Apr 2025 10:36:17 +1000 Subject: [PATCH 3/5] Update modules/ROOT/partials/configuration/onboarding.adoc --- modules/ROOT/partials/configuration/onboarding.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/partials/configuration/onboarding.adoc b/modules/ROOT/partials/configuration/onboarding.adoc index 5129909245..a39b2a7b56 100644 --- a/modules/ROOT/partials/configuration/onboarding.adoc +++ b/modules/ROOT/partials/configuration/onboarding.adoc @@ -1,4 +1,4 @@ -= Open source promotion += Cloud promotion [[onboarding]] == `+onboarding+` From 520dd1ca53a1f431e8f416e58aae314944245c62 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 8 Apr 2025 10:36:30 +1000 Subject: [PATCH 4/5] Update modules/ROOT/partials/configuration/promotion.adoc --- modules/ROOT/partials/configuration/promotion.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/partials/configuration/promotion.adoc b/modules/ROOT/partials/configuration/promotion.adoc index fea18861f3..cd09f1eb21 100644 --- a/modules/ROOT/partials/configuration/promotion.adoc +++ b/modules/ROOT/partials/configuration/promotion.adoc @@ -1,4 +1,4 @@ -= Cloud promotion += Open source promotion [[promotion]] == `+promotion+` From 577088012a3efd06a0be84abf51400042d76e53c Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Wed, 9 Apr 2025 09:53:40 +1000 Subject: [PATCH 5/5] DOC-3131: Fix sidebar nesting issue. --- modules/ROOT/partials/configuration/onboarding.adoc | 7 ++----- modules/ROOT/partials/configuration/promotion.adoc | 7 ++----- .../partials/misc/premium-upgrade-promotion-option.adoc | 5 +++-- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/modules/ROOT/partials/configuration/onboarding.adoc b/modules/ROOT/partials/configuration/onboarding.adoc index a39b2a7b56..2e0b0952a2 100644 --- a/modules/ROOT/partials/configuration/onboarding.adoc +++ b/modules/ROOT/partials/configuration/onboarding.adoc @@ -1,5 +1,3 @@ -= Cloud promotion - [[onboarding]] == `+onboarding+` @@ -13,12 +11,11 @@ The promotion will automatically disappear when the trial ends. *Possible values:* `+true+`, `+false+` -=== Example: using cloud `+onboarding+` - +.Example: using cloud `+onboarding+` [source,js] ---- tinymce.init({ selector: "textarea", // change this value according to your HTML onboarding: false }); ----- +---- \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/promotion.adoc b/modules/ROOT/partials/configuration/promotion.adoc index cd09f1eb21..f1dde7a210 100644 --- a/modules/ROOT/partials/configuration/promotion.adoc +++ b/modules/ROOT/partials/configuration/promotion.adoc @@ -1,7 +1,5 @@ -= Open source promotion - [[promotion]] -== `+promotion+` +== `+promotion+` The open source version of {productname} contains a promotion for paid features. This promotion can be toggled on or off with the `+promotion+` option. @@ -11,8 +9,7 @@ The open source version of {productname} contains a promotion for paid features. *Possible values:* `+true+`, `+false+` -=== Example: using open source `+promotion+` - +.Example: using open source `+promotion+` [source,js] ---- tinymce.init({ diff --git a/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc b/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc index 6c88806be9..f056248aaf 100644 --- a/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc +++ b/modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc @@ -1,6 +1,7 @@ -[[options]] -== Options +== Open source promotion include::partial$configuration/promotion.adoc[leveloffset=+1] +== Cloud promotion + include::partial$configuration/onboarding.adoc[leveloffset=+1] \ No newline at end of file