DOC-3215: Docs changes for new onboarding feature. #3726

kemister85 · 2025-05-14T03:38:30Z

Ticket: DOC-3215

Site: Cloud-troubleshooting-update
Site: Promotions- onboarding

Changes:

1. Onboarding Feature Documentation

Restored the section explaining how to hide the Onboarding screen and button on the Premium upgrade promotion page.
Updated guidance for the "Finish setting up" screen, which now only appears when the URL explicitly includes apiKey='no-api-key'.
Clarified that for all other cases (e.g., missing, invalid, or mistyped API keys), the standard error messages will continue to be displayed as before.

2. Configuration Options

Standardized all integration snippet examples across the documentation to use apiKey='no-api-key' for consistency, replacing variations like:
- apiKey="your-api-key"
- apiKey="your-tiny-cloud-api-key"
- Any other placeholder variations previously in use.

3. Cloud Troubleshooting Updates

Updated the Cloud Troubleshooting page to reflect the current behavior, including:
- A dedicated section for 'no-api-key', explaining what users should expect when using this placeholder.
- Detailed guidance on when users may encounter the "A valid API key is required" message:
  - "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."

Pre-checks:

Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/.

Review:

Documentation Team Lead has reviewed

modules/ROOT/pages/cloud-troubleshooting.adoc

modules/ROOT/partials/configuration/onboarding.adoc

…key errors.

modules/ROOT/pages/cloud-troubleshooting.adoc

Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com>

ShiridiGandham

LGTM

* DOC-3151: TinyMCE 7.9.0 release notes and community changelog. * DOC-3151: Spellchecking with a language that does not match the content no longer overloads the spelling server. (#3704) * DOC-3151: Adjusted spacing in accessibility checker component for better visual alignment (#3711) * DOC-3151: Adjusted spacing in accessibility checker component for better visual alignment * Update modules/ROOT/pages/7.9.0-release-notes.adoc * DOC-3151: Removed deprecated CSS media selector -ms-high-contrast. (#3712) * DOC-3151: Pressing `enter` before a floating image sometimes duplicated the image. (#3716) * DOC-3151: Pressing before a floating image sometimes duplicated the image. * Update modules/ROOT/pages/7.9.0-release-notes.adoc * Update modules/ROOT/pages/7.9.0-release-notes.adoc * Update modules/ROOT/pages/7.9.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * DOC-3151: Tabbing inside a figcaption element no longer shows two text insertion carets. (#3710) * DOC-3151: Aspect ratio was not properly calculated when uploading images wider than the editor. (#3713) * DOC-3151: Inline dialog dropdowns reposition when the dialog is dragged or the window is scrolled. (#3715) * DOC-3151: Changed word-capture regex for abbreviations to allow larger abbreviations. (#3717) * DOC-3151: Changed word-capture regex for abbreviations to allow larger abbreviations. * DOC-3151: Refined content and included example of the fix. * Update modules/ROOT/pages/7.9.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * DOC-3151: the toolbar did not consider the entire space in some cases if there was a horizontal scroll. (#3718) Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * DOC-3151: Update default list icons with new asset files. (#3696) * DOC-3151: Resize cursor is now the correct direction for each resize mode. (#3697) * DOC-3151: Resize cursor is now the correct direction for each resize mode. * DOC-3151: update thanks message to note. * DOC-3151: ContextFormSizeInput lock button has been repositioned between the width and height inputs. (#3698) * DOC-3151: Spelling Autocorrect no longer requires the spelling service. (#3705) * DOC-3151: If `style_formats` is empty the button is now disabled. (#3709) * DOC-3151: If style_formats is empty the button is now disabled. * Update modules/ROOT/pages/7.9.0-release-notes.adoc * DOC-3151: Editor did not scroll into viewport on receiving focus on Chrome and Safari. (#3708) * DOC-3151: Japanese keyboard could insert content while the editor was in `readonly` mode (#3719) * DOC-3151: Japanese keyboard could insert content while the editor was in readonly mode * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> --------- Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> * DOC-3151: Autolink behavior updated to preserve existing links. (#3714) * DOC-3151: Added new disc style option for unordered lists. (#3695) * DOC-3151: Table resizers are now visible when inline editor has a z-index property. (#3721) * DOC-3151: The `mceInsertContent` command could delete the parent block element when an anchor was selected. (#3723) * DOC-3151: The mceInsertContent command could delete the parent block element when an anchor was selected. * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> --------- Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> * DOC-3151: Copy edits, template cleanup & included changelog for TinyMCE 7.9.0. * DOC-3215: Docs changes for new onboarding feature. (#3726) * DOC-3215: Docs changes for new onboarding feature. * Update modules/ROOT/pages/cloud-troubleshooting.adoc * Update modules/ROOT/pages/cloud-troubleshooting.adoc * Update modules/ROOT/partials/configuration/onboarding.adoc * DOC-3151: coipy edits, and changes. * DOC-3151: Refine cloud troubleshooting documentation for invalid API key errors. * DOC-3151: Remove trail-explore-features.png file. * Update modules/ROOT/pages/cloud-troubleshooting.adoc Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> * DOC-3151: fix level heading. --------- Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> * DOC-3151: Select UI elements was not properly styled on Chrome version 136. (#3725) * DOC-3151: Select UI elements was not properly styled on Chrome version 136. * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> * Update modules/ROOT/pages/changelog.adoc Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> --------- Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> * DOC-3151: bump api-version to 7.9.0. --------- Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud>

* DOC-3203: TinyMCE 7.9.0 Release Documentation. * DOC-3151: TinyMCE 7.9.0 release notes and community changelog. (#3694) * DOC-3151: TinyMCE 7.9.0 release notes and community changelog. * DOC-3151: Spellchecking with a language that does not match the content no longer overloads the spelling server. (#3704) * DOC-3151: Adjusted spacing in accessibility checker component for better visual alignment (#3711) * DOC-3151: Adjusted spacing in accessibility checker component for better visual alignment * Update modules/ROOT/pages/7.9.0-release-notes.adoc * DOC-3151: Removed deprecated CSS media selector -ms-high-contrast. (#3712) * DOC-3151: Pressing `enter` before a floating image sometimes duplicated the image. (#3716) * DOC-3151: Pressing before a floating image sometimes duplicated the image. * Update modules/ROOT/pages/7.9.0-release-notes.adoc * Update modules/ROOT/pages/7.9.0-release-notes.adoc * Update modules/ROOT/pages/7.9.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * DOC-3151: Tabbing inside a figcaption element no longer shows two text insertion carets. (#3710) * DOC-3151: Aspect ratio was not properly calculated when uploading images wider than the editor. (#3713) * DOC-3151: Inline dialog dropdowns reposition when the dialog is dragged or the window is scrolled. (#3715) * DOC-3151: Changed word-capture regex for abbreviations to allow larger abbreviations. (#3717) * DOC-3151: Changed word-capture regex for abbreviations to allow larger abbreviations. * DOC-3151: Refined content and included example of the fix. * Update modules/ROOT/pages/7.9.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * DOC-3151: the toolbar did not consider the entire space in some cases if there was a horizontal scroll. (#3718) Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> * DOC-3151: Update default list icons with new asset files. (#3696) * DOC-3151: Resize cursor is now the correct direction for each resize mode. (#3697) * DOC-3151: Resize cursor is now the correct direction for each resize mode. * DOC-3151: update thanks message to note. * DOC-3151: ContextFormSizeInput lock button has been repositioned between the width and height inputs. (#3698) * DOC-3151: Spelling Autocorrect no longer requires the spelling service. (#3705) * DOC-3151: If `style_formats` is empty the button is now disabled. (#3709) * DOC-3151: If style_formats is empty the button is now disabled. * Update modules/ROOT/pages/7.9.0-release-notes.adoc * DOC-3151: Editor did not scroll into viewport on receiving focus on Chrome and Safari. (#3708) * DOC-3151: Japanese keyboard could insert content while the editor was in `readonly` mode (#3719) * DOC-3151: Japanese keyboard could insert content while the editor was in readonly mode * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> --------- Co-authored-by: Karl Kemister-Sheppard <karlkemistersheppard@gmail.com> Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> * DOC-3151: Autolink behavior updated to preserve existing links. (#3714) * DOC-3151: Added new disc style option for unordered lists. (#3695) * DOC-3151: Table resizers are now visible when inline editor has a z-index property. (#3721) * DOC-3151: The `mceInsertContent` command could delete the parent block element when an anchor was selected. (#3723) * DOC-3151: The mceInsertContent command could delete the parent block element when an anchor was selected. * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> --------- Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> * DOC-3151: Copy edits, template cleanup & included changelog for TinyMCE 7.9.0. * DOC-3215: Docs changes for new onboarding feature. (#3726) * DOC-3215: Docs changes for new onboarding feature. * Update modules/ROOT/pages/cloud-troubleshooting.adoc * Update modules/ROOT/pages/cloud-troubleshooting.adoc * Update modules/ROOT/partials/configuration/onboarding.adoc * DOC-3151: coipy edits, and changes. * DOC-3151: Refine cloud troubleshooting documentation for invalid API key errors. * DOC-3151: Remove trail-explore-features.png file. * Update modules/ROOT/pages/cloud-troubleshooting.adoc Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> * DOC-3151: fix level heading. --------- Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> * DOC-3151: Select UI elements was not properly styled on Chrome version 136. (#3725) * DOC-3151: Select UI elements was not properly styled on Chrome version 136. * Update modules/ROOT/pages/7.9.0-release-notes.adoc Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> * Update modules/ROOT/pages/changelog.adoc Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> --------- Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> * DOC-3151: bump api-version to 7.9.0. --------- Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud> --------- Co-authored-by: CODE:AG <57781325+abhinavgandham@users.noreply.github.com> Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com> Co-authored-by: tiny-ben-tran <ben.tran@tiny.cloud>

DOC-3215: Docs changes for new onboarding feature.

d99a9b0

kemister85 requested review from a team, TheSpyder, jscasca, kimwoodfield and ltrouton and removed request for a team May 14, 2025 03:43

kemister85 added this to the TinyMCE 7.9.0 milestone May 14, 2025

kemister85 added the upcoming release Documentation for features currently under development/QA label May 14, 2025

kemister85 marked this pull request as ready for review May 14, 2025 03:43

kemister85 requested review from a team, abhinavgandham and soritaheng as code owners May 14, 2025 03:43

kemister85 requested review from EkimChau, MitchC1999 and Skylite73 and removed request for a team May 14, 2025 03:43

MitchC1999 approved these changes May 14, 2025

View reviewed changes

kimwoodfield approved these changes May 14, 2025

View reviewed changes

kemister85 commented May 14, 2025

View reviewed changes

modules/ROOT/pages/cloud-troubleshooting.adoc Outdated Show resolved Hide resolved

Update modules/ROOT/pages/cloud-troubleshooting.adoc

7ec8bf3

kemister85 commented May 14, 2025

View reviewed changes

modules/ROOT/pages/cloud-troubleshooting.adoc Outdated Show resolved Hide resolved

kemister85 commented May 14, 2025

View reviewed changes

modules/ROOT/partials/configuration/onboarding.adoc Outdated Show resolved Hide resolved

kemister85 added 5 commits May 14, 2025 19:33

Update modules/ROOT/pages/cloud-troubleshooting.adoc

eee8876

Update modules/ROOT/partials/configuration/onboarding.adoc

a255ec9

DOC-3151: coipy edits, and changes.

99926c3

DOC-3151: Refine cloud troubleshooting documentation for invalid API …

242e526

…key errors.

DOC-3151: Remove trail-explore-features.png file.

b0f739e

ShiridiGandham reviewed May 14, 2025

View reviewed changes

modules/ROOT/pages/cloud-troubleshooting.adoc Outdated Show resolved Hide resolved

Update modules/ROOT/pages/cloud-troubleshooting.adoc

f137fb0

Co-authored-by: shirqa <43625458+ShiridiGandham@users.noreply.github.com>

kemister85 requested a review from ShiridiGandham May 14, 2025 23:12

DOC-3151: fix level heading.

3aed410

ShiridiGandham approved these changes May 14, 2025

View reviewed changes

kemister85 merged commit 9c2eab4 into feature/7.9.0/DOC-3151 May 15, 2025
4 checks passed

kemister85 deleted the feature/7.9.0/DOC-3151_DOC-3215 branch May 15, 2025 00:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOC-3215: Docs changes for new onboarding feature. #3726

DOC-3215: Docs changes for new onboarding feature. #3726

Uh oh!

kemister85 commented May 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ShiridiGandham left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DOC-3215: Docs changes for new onboarding feature. #3726

DOC-3215: Docs changes for new onboarding feature. #3726

Uh oh!

Conversation

kemister85 commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1. Onboarding Feature Documentation

2. Configuration Options

3. Cloud Troubleshooting Updates

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ShiridiGandham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kemister85 commented May 14, 2025 •

edited

Loading