DOC-3517: Clarify service vs plugin distinction in on-premises service docs (#4159)

kemister85 · web-flow · commit 82fee2b8603b · 2026-06-30T15:19:48.000+10:00
* DOC-3517: Clarify service vs plugin distinction in on-premises service docs Rewrite overview sections for all five on-premises service pages to clearly distinguish between the server-side service and the editor plugin it supports. Services with APIs (Export to PDF, Import/Export Word) now document both plugin-backed and direct API usage paths. Affected pages: - Hyperlinking service - Image Proxy service - Spelling service - Export to PDF service - Import from Word and Export to Word service * DOC-3517: Clarify Hyperlinking and Image Proxy service responsibilities Attribute link validation and media embed resolution to their respective plugins for the Hyperlinking service, and correct the Image Proxy overview to state it only fetches image content, performs no editing, and does not resolve media embeds.
diff --git a/modules/ROOT/pages/individual-export-to-pdf-on-premises.adoc b/modules/ROOT/pages/individual-export-to-pdf-on-premises.adoc
@@ -1,6 +1,6 @@
-= Deploy the {productname} {pluginname} service server-side component using Docker (individually licensed)
+= Deploy the {productname} {pluginname} server-side service using Docker (individually licensed)
 :navtitle: Export to PDF
-:description: Setting up Export to PDF using Docker.
+:description: Deploy the Export to PDF server-side service using Docker.
 :keywords: server-side, docker, export-to-pdf, on-premises
 :pluginname: Export to PDF
 
diff --git a/modules/ROOT/pages/individual-hyperlinking-container.adoc b/modules/ROOT/pages/individual-hyperlinking-container.adoc
@@ -1,6 +1,6 @@
-= Deploy the {productname} Hyperlinking server-side component using Docker
+= Deploy the {productname} Hyperlinking server-side service using Docker
 :navtitle: Hyperlinking service
-:description: How-to deploy the {productname} Hyperlinking server-side component using Docker.
+:description: Deploy the {productname} Hyperlinking server-side service using Docker.
 :shbundledockerfiles: false
 :linkcheckerplugin: Link Checker 
 :mediaembedplugin: Enhanced Media Embed 
diff --git a/modules/ROOT/pages/individual-image-proxy-container.adoc b/modules/ROOT/pages/individual-image-proxy-container.adoc
@@ -1,6 +1,6 @@
-= Deploy the {productname} Image Proxy service server-side component using Docker
+= Deploy the {productname} Image Proxy server-side service using Docker
 :navtitle: Image Proxy service
-:description: How-to deploy the {productname} Image Proxy service server-side component using Docker.
+:description: Deploy the {productname} Image Proxy server-side service using Docker.
 :shbundledockerfiles: false
 :pluginname: Image Editing
 
diff --git a/modules/ROOT/pages/individual-import-from-word-and-export-to-word-on-premises.adoc b/modules/ROOT/pages/individual-import-from-word-and-export-to-word-on-premises.adoc
@@ -1,6 +1,6 @@
-= Deploy the {productname} {pluginname} service server-side component using Docker (individually licensed)
+= Deploy the {productname} {pluginname} server-side service using Docker (individually licensed)
 :navtitle: Import from Word and Export to Word
-:description: Setting up Import from Word and Export to Word using Docker.
+:description: Deploy the Import from Word and Export to Word server-side service using Docker.
 :keywords: server-side, docker, import-from-word, export-to-word, on-premises
 :pluginname: Import from Word and Export to Word
 
diff --git a/modules/ROOT/pages/individual-spelling-container.adoc b/modules/ROOT/pages/individual-spelling-container.adoc
@@ -1,6 +1,6 @@
-= Deploy the {productname} Spelling server-side component using Docker
+= Deploy the {productname} Spelling server-side service using Docker
 :navtitle: Spelling service
-:description: How-to deploy the {productname} Spelling server-side component using Docker.
+:description: Deploy the {productname} Spelling server-side service using Docker.
 :shbundledockerfiles: false
 :pluginname: Spell Checker
 
diff --git a/modules/ROOT/partials/docker/hyperlinking-service/hyperlinking-service-overview.adoc b/modules/ROOT/partials/docker/hyperlinking-service/hyperlinking-service-overview.adoc
@@ -1,10 +1,10 @@
 [[overview]]
 == Overview
 
-The On-Premises version of the link:https://www.tiny.cloud/tinymce/features/link-checker/[{linkcheckerplugin}^] and link:https://www.tiny.cloud/tinymce/features/enhanced-media-embed/[{mediaembedplugin}^] is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud.
+The Hyperlinking service is a server-side component that provides both link validation and media embed resolution. It runs on-premises within the host infrastructure and powers the link:https://www.tiny.cloud/tinymce/features/link-checker/[{linkcheckerplugin}^] plugin, which validates links, and the link:https://www.tiny.cloud/tinymce/features/enhanced-media-embed/[{mediaembedplugin}^] plugin, which resolves media URLs into embeddable content, in the {productname} editor. Once deployed, each plugin must be configured separately to connect to this service.
 
-The only requirement to run these services On-Premises is a container runtime or orchestration tool e.g. Docker, Kubernetes, Podman. 
+The only requirement to run the Hyperlinking service on-premises is a container runtime or orchestration tool, such as Docker, Kubernetes, or Podman.
 
-A valid access token is required to access the Tiny Cloud Docker registry and pull the Docker image. Contact link:https://www.tiny.cloud/contact/[{companyname} Support^] to request the access token. 
+A valid access token is required to access the {companyname} Cloud Docker registry and pull the Docker image. Contact link:https://www.tiny.cloud/contact/[{companyname} Support^] to request the access token.
 
-include::partial$misc/admon-dont-push-docker-images.adoc[]
+include::partial$misc/admon-dont-push-docker-images.adoc[]
diff --git a/modules/ROOT/partials/docker/image-proxy-service/image-proxy-service-overview.adoc b/modules/ROOT/partials/docker/image-proxy-service/image-proxy-service-overview.adoc
@@ -1,10 +1,10 @@
 [[overview]]
 == Overview
 
-The On-Premises version of link:https://www.tiny.cloud/docs/tinymce/latest/editimage/[{pluginname}] is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud.
+The Image Proxy service is a server-side component that fetches and serves image content for the {productname} editor. It runs on-premises within the host infrastructure and provides the back-end capabilities used by the link:https://www.tiny.cloud/docs/tinymce/latest/editimage/[{pluginname}] plugin. The service only retrieves image content; image editing is performed in the browser, and the service does not resolve media embeds.
 
-The only requirement to run this service On-Premises is a container runtime or orchestration tool e.g. Docker, Kubernetes, Podman.
+The only requirement to run the Image Proxy service on-premises is a container runtime or orchestration tool, such as Docker, Kubernetes, or Podman.
 
 A valid access token is required to access the {companyname} Cloud Docker registry and pull the Docker image. Contact link:https://www.tiny.cloud/contact/[{companyname} Support^] to request the access token.
 
-include::partial$misc/admon-dont-push-docker-images.adoc[]
+include::partial$misc/admon-dont-push-docker-images.adoc[]
diff --git a/modules/ROOT/partials/docker/spelling-service/spelling-service-overview.adoc b/modules/ROOT/partials/docker/spelling-service/spelling-service-overview.adoc
@@ -1,10 +1,10 @@
 [[overview]]
 == Overview
 
-The On-Premises version of the link:https://www.tiny.cloud/tinymce/features/spell-checker/[{pluginname}^] is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud.
+The Spelling service is a server-side component that provides spell checking and language processing capabilities. It runs on-premises within the host infrastructure and powers the link:https://www.tiny.cloud/tinymce/features/spell-checker/[{pluginname}^] plugin in the {productname} editor.
 
-The only requirement to run these services On-Premises is a container runtime or orchestration tool e.g. Docker, Kubernetes, Podman.
+The only requirement to run the Spelling service on-premises is a container runtime or orchestration tool, such as Docker, Kubernetes, or Podman.
 
-A valid access token is required to access the {companyname} Cloud Docker registry and pull the Docker image. Contact link:https://www.tiny.cloud/contact/[{companyname} Support^] to request the access token. 
+A valid access token is required to access the {companyname} Cloud Docker registry and pull the Docker image. Contact link:https://www.tiny.cloud/contact/[{companyname} Support^] to request the access token.
 
-include::partial$misc/admon-dont-push-docker-images.adoc[]
+include::partial$misc/admon-dont-push-docker-images.adoc[]
diff --git a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-overview.adoc b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-overview.adoc
@@ -1,7 +1,10 @@
 [[overview]]
 == Overview
 
-The On-Premises version of the {pluginname} Converter is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud. It contains all the features of the {pluginname} Converter available as SaaS.
+The Export to PDF service is a server-side component that converts HTML content into PDF files. It runs on-premises within the host infrastructure and can be used in two ways:
+
+* As the back end for the xref:exportpdf.adoc[{pluginname}] plugin in the {productname} editor.
+* Directly via its REST API, independent of the editor.
 
 [IMPORTANT]
 ====
@@ -10,6 +13,6 @@ To use {productname} 8.4.0 or newer with the Export to PDF plugin, the on-premis
 
 A valid service license key is required to run the {pluginname} Converter on-premises service. This key is separate from the {productname} editor license key. An access token is also required to access the {companyname} Cloud Docker registry and pull the Docker image. See xref:service-license-keys.adoc[Service license keys] for more information.
 
-To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial service license key and Docker access token. 
+To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial service license key and Docker access token.
 
-The only requirement to run {pluginname} On-Premises is a container runtime or orchestration tool e.g. Docker, Kubernetes, Podman. 
+The only requirement to run the {pluginname} service on-premises is a container runtime or orchestration tool, such as Docker, Kubernetes, or Podman.
diff --git a/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-overview-on-premises.adoc b/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-overview-on-premises.adoc
@@ -1,12 +1,18 @@
 [[overview]]
 == Overview
 
-{pluginname} is a set of two converter services that allow for both exporting a structured HTML content (e.g. created with {productname} WYSIWYG editor) into a `.docx` Microsoft Word file and for importing content from `.docx` and `.dotx` files and converting it into a styled HTML document.
+The {pluginname} service is a set of two server-side converter components that run on-premises within the host infrastructure. They provide:
+
+* Export: converting structured HTML content (such as content created with the {productname} editor) into `.docx` Microsoft Word files.
+* Import: converting content from `.docx` and `.dotx` files into styled HTML.
+
+These services can be used in two ways:
+
+* As the back end for the xref:importword.adoc[Import from Word] and xref:exportword.adoc[Export to Word] plugins in the {productname} editor.
+* Directly via the REST API, independent of the editor.
 
 A valid service license key is required to run the {pluginname} on-premises service. This key is separate from the {productname} editor license key. An access token is also required to access the {companyname} Cloud Docker registry and pull the Docker image. See xref:service-license-keys.adoc[Service license keys] for more information.
 
 To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial service license key and Docker access token.
 
-The documentation in this section refers to a simplified version of the {pluginname} On-Premises which was designed to be easy to set up and maintain (while preserving all the features). It also lowers the running costs by reducing the number of servers required to run the whole application to the minimum.
-
-The only requirement to run {pluginname} On-Premises is a container runtime or orchestration tool e.g. Docker, Kubernetes, Podman.
+The only requirement to run the {pluginname} service on-premises is a container runtime or orchestration tool, such as Docker, Kubernetes, or Podman.
