-
Notifications
You must be signed in to change notification settings - Fork 220
DOC-3189: Refactor promotion documentation and update references to new promotions page #3674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kemister85
merged 5 commits into
feature/7.8.0/DOC-3131
from
feature/7.8.0/DOC-3131_DOC-3191
Apr 8, 2025
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
51af4ff
DOC-3189: Refactor promotion documentation and update references to n…
kemister85 7132cba
DOC-3190: Update promotion documentation to clarify options for open …
kemister85 2c9ff80
Update modules/ROOT/partials/configuration/onboarding.adoc
kemister85 520dd1c
Update modules/ROOT/partials/configuration/promotion.adoc
kemister85 5770880
DOC-3131: Fix sidebar nesting issue.
kemister85 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| = Premium upgrade promotion | ||
| :navtitle: {productname} Premium upgrade promotion | ||
| :description: Editor options related to turning the Premium promotion display off | ||
| :keywords: upgrade, promotion, premium, button, lightning bolt | ||
|
|
||
| include::partial$misc/premium-upgrade-promotion-option.adoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| = Cloud 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 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 | ||
| }); | ||
| ---- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,22 @@ | ||
| = 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+` | ||
|
|
||
| *Default value:* `+true+` in Community self-hosted instances; otherwise `+false+`. | ||
|
|
||
| *Possible values:* `+true+`, `+false+` | ||
|
|
||
| See xref:editor-premium-upgrade-promotion.adoc#premium-upgrade-promotion-defaults[Premium upgrade promotion defaults] for details. | ||
|
|
||
| === Example: using `+promotion+` | ||
| === Example: using open source `+promotion+` | ||
|
|
||
| [source,js] | ||
| ---- | ||
| 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. | ||
| ---- | ||
8 changes: 5 additions & 3 deletions
8
modules/ROOT/partials/misc/premium-upgrade-promotion-option.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| [[premium-upgrade-promotion-option]] | ||
| == Premium upgrade promotion option | ||
| [[options]] | ||
|
kemister85 marked this conversation as resolved.
Outdated
|
||
| == Options | ||
|
|
||
| include::partial$configuration/promotion.adoc[leveloffset=+1] | ||
| include::partial$configuration/promotion.adoc[leveloffset=+1] | ||
|
|
||
| include::partial$configuration/onboarding.adoc[leveloffset=+1] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.