Skip to content

Commit ec9f554

Browse files
authored
DOC-3189: Refactor promotion documentation and update references to new promotions page (#3674)
* DOC-3189: Refactor promotion documentation and update references to new promotions page. * DOC-3190: Update promotion documentation to clarify options for open source and cloud versions. * Update modules/ROOT/partials/configuration/onboarding.adoc * Update modules/ROOT/partials/configuration/promotion.adoc * DOC-3131: Fix sidebar nesting issue.
1 parent 06bced6 commit ec9f554

File tree

7 files changed

+39
-43
lines changed

7 files changed

+39
-43
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@
239239
** xref:editor-important-options.adoc[Integration options]
240240
** xref:editor-size-options.adoc[Size]
241241
** xref:editor-save-and-submit.adoc[Save and submit]
242-
** xref:editor-premium-upgrade-promotion.adoc[Premium upgrade promotion]
242+
** xref:promotions.adoc[Promotions]
243243
* Interface
244244
** Editor modes
245245
*** xref:use-tinymce-classic.adoc[Classic editing mode]

modules/ROOT/pages/editor-premium-upgrade-promotion.adoc

Lines changed: 0 additions & 27 deletions
This file was deleted.

modules/ROOT/pages/initial-configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Editor options related to saving or submitting editor content.
2929

3030
|
3131
[.lead]
32-
xref:editor-premium-upgrade-promotion.adoc[Premium upgrade promotion]
32+
xref:promotions.adoc[Promotions]
3333

3434
Editor options related to turning the Premium promotion display off.
3535

modules/ROOT/pages/promotions.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
= Premium upgrade promotion
2+
:navtitle: {productname} Premium upgrade promotion
3+
:description: Editor options related to turning the Premium promotion display off
4+
:keywords: upgrade, promotion, premium, button, lightning bolt
5+
6+
include::partial$misc/premium-upgrade-promotion-option.adoc[]
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[[onboarding]]
2+
== `+onboarding+`
3+
4+
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.
5+
6+
The promotion will automatically disappear when the trial ends.
7+
8+
*Type:* `+Boolean+`
9+
10+
*Default value:* `+true+` for cloud instances; otherwise `+false+`.
11+
12+
*Possible values:* `+true+`, `+false+`
13+
14+
.Example: using cloud `+onboarding+`
15+
[source,js]
16+
----
17+
tinymce.init({
18+
selector: "textarea", // change this value according to your HTML
19+
onboarding: false
20+
});
21+
----
Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,19 @@
11
[[promotion]]
2-
== `+promotion+`
2+
== `+promotion+`
33

4-
{productname} 6.2 and later includes the `promotion` option. It controls the presentation or otherwise of a Tiny-specific promotion button.
4+
The open source version of {productname} contains a promotion for paid features. This promotion can be toggled on or off with the `+promotion+` option.
55

66
*Type:* `+Boolean+`
77

88
*Default value:* `+true+` in Community self-hosted instances; otherwise `+false+`.
99

1010
*Possible values:* `+true+`, `+false+`
1111

12-
See xref:editor-premium-upgrade-promotion.adoc#premium-upgrade-promotion-defaults[Premium upgrade promotion defaults] for details.
13-
14-
=== Example: using `+promotion+`
15-
12+
.Example: using open source `+promotion+`
1613
[source,js]
1714
----
1815
tinymce.init({
1916
selector: "textarea", // change this value according to your HTML
2017
promotion: true
2118
});
22-
----
23-
24-
The *Upgrade* promotion appears in the unused corner of the {productname} menu bar. Consequently it does not appear if the menu bar is disabled.
25-
26-
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.
19+
----
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
[[premium-upgrade-promotion-option]]
2-
== Premium upgrade promotion option
1+
== Open source promotion
32

4-
include::partial$configuration/promotion.adoc[leveloffset=+1]
3+
include::partial$configuration/promotion.adoc[leveloffset=+1]
4+
5+
== Cloud promotion
6+
7+
include::partial$configuration/onboarding.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)