Skip to content

Conversation

@kemister85
Copy link
Contributor

@kemister85 kemister85 commented Nov 13, 2025

Ticket: DOC-3313

Site: Staging branch

Site: new- installation-cloud/
Site: new- installation-self-hosted/
Site: new- zip

Site: cloud
Site: package manager (npm)
Site: .zip method

Site: FIX: webpack-es6-npm/ broken partials

Changes:

Refactor Installation Documentation Structure

Overview

This PR refactors the installation documentation by splitting the single installation.adoc page into three separate, focused pages based on installation method: Cloud, Self-hosted (package managers), and ZIP. This improves navigation and makes it easier for users to find the installation method that matches their use case.

New Files

Installation Pages

  • modules/ROOT/pages/installation-cloud.adoc - New page dedicated to Cloud/CDN installation method

    • Includes quick start guide link
    • Lists all supported framework integrations (React, Angular, Vue.js, Blazor, Svelte, Web Component, jQuery)
    • Lists backend integrations (Django, Laravel, Ruby on Rails)
    • Lists other integrations (Bootstrap)
  • modules/ROOT/pages/installation-self-hosted.adoc - New page dedicated to package manager installation method

    • Includes quick start guide link
    • Lists all supported framework integrations with package manager
    • Lists backend integrations (Laravel, Ruby on Rails, Express.js)
    • Lists other integrations (Shadow DOM, PHP, .NET, Bower, WordPress)
    • Includes package manager reference table (npm, Yarn, Bower, Composer, NuGet)
  • modules/ROOT/pages/installation-zip.adoc - New page dedicated to ZIP file installation method

    • Includes quick start guide link
    • Lists all supported framework integrations with ZIP
    • Lists backend integrations (Django, Laravel, Ruby on Rails)
    • Lists other integrations (Bootstrap)

New Partials

  • modules/ROOT/partials/install/initialize-editor-cloud.adoc - Partial for initializing editor with Cloud CDN
  • modules/ROOT/partials/install/initialize-editor-self-hosted.adoc - Partial for initializing editor with self-hosted installation
  • modules/ROOT/partials/install/save-content.adoc - Reusable partial for saving editor content
  • modules/ROOT/partials/module-loading/bundling-vite-es6-npm_vite-dependencies.adoc - New partial for Vite dependencies

Modified Files

Navigation

  • modules/ROOT/nav.adoc - Updated navigation structure to include three new installation sub-pages:
    • Cloud (with all cloud-based integrations)
    • Self-hosted (with all package manager integrations)
    • ZIP (with all ZIP-based integrations)

Main Installation Page

  • modules/ROOT/pages/installation.adoc - Simplified to act as an overview page with links to the three installation methods

Integration Pages

  • modules/ROOT/pages/browserify-cjs-npm.adoc - Updated references
  • modules/ROOT/pages/cloud-quick-start.adoc - Updated to use new partials
  • modules/ROOT/pages/dotnet-projects.adoc - Updated references
  • modules/ROOT/pages/invalid-api-key.adoc - Updated references
  • modules/ROOT/pages/npm-projects.adoc - Updated references
  • modules/ROOT/pages/php-projects.adoc - Updated references
  • modules/ROOT/pages/rollup-es6-npm.adoc - Updated references
  • modules/ROOT/pages/tinydrive-java.adoc - Updated references
  • modules/ROOT/pages/vite-es6-npm.adoc - Updated references
  • modules/ROOT/pages/webpack-cjs-npm.adoc - Updated references
  • modules/ROOT/pages/webpack-es6-npm.adoc - Updated references
  • modules/ROOT/pages/zip-install.adoc - Updated references

Deleted Pages

  • modules/ROOT/pages/bower-projects.adoc - Removed as it was deprecated by maintainers in 2017

Partials

  • modules/ROOT/partials/install/basic-quickstart-base.adoc - Updated to work with new structure
  • modules/ROOT/partials/integrations/angular-tech-ref.adoc - Updated references
  • modules/ROOT/partials/integrations/react-quick-start.adoc - Updated references
  • modules/ROOT/partials/integrations/svelte-tech-ref.adoc - Updated references
  • modules/ROOT/partials/misc/quickstart-next-steps.adoc - Updated references
  • modules/ROOT/partials/module-loading/webpack-dev-dependencies.adoc - Updated references
  • modules/ROOT/partials/what-is-tinymce.adoc - Updated to reference new installation pages

Benefits

  • Improved Navigation: Users can now directly access documentation for their specific installation method
  • Better Organization: Installation methods are clearly separated, making it easier to maintain and update
  • Enhanced Discoverability: Each installation method page lists all relevant integrations in one place
  • Code Reusability: New partials allow for consistent content across different installation methods
  • Clearer Structure: The main installation page now serves as a clear entry point to the three methods

Pre-checks:

  • Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/.
  • modules/ROOT/nav.adoc has been updated (if applicable).
  • Included a release note entry for any New product features.
  • If this is a minor release, updated productminorversion in antora.yml and added new supported versions entry in modules/ROOT/partials/misc/supported-versions.adoc.

Review:

  • Documentation Team Lead has reviewed

… bundling pages and key architectural changes.
@kemister85 kemister85 requested review from a team, ShiridiGandham, TheSpyder, ltrouton, metricjs and tiny-ben-tran and removed request for a team November 13, 2025 05:59
Copy link
Contributor

@ShiridiGandham ShiridiGandham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kemister85 kemister85 merged commit bf4db89 into tinymce/8 Nov 14, 2025
5 checks passed
@kemister85 kemister85 deleted the hotfix/8/DOC-3313_v2 branch November 14, 2025 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants