Skip to content

Commit c9d4fa2

Browse files
kemister85tjdett
andauthored
DOC-3231: Refactor documentation for server-side components to support Docker deployment. (#3757)
* DOC-3231: Refactor documentation for server-side components to support Docker deployment - Removed the deprecated logging services configuration documentation. - Updated references from WAR file deployment to Docker container deployment across multiple documents. - Revised installation and configuration instructions for spellchecking, image proxy, and media embed services to reflect Docker usage. - Added new sections for Docker image retrieval, configuration, and requirements. - Clarified system requirements and troubleshooting steps for Dockerized services. - Adjusted custom dictionaries and Hunspell dictionaries path requirements to remove references to Java services. - Updated supported application servers section to emphasize Docker as the primary deployment method. * DOC-3231: Remove deprecated server-side component installation documentation duplication page. * File cleanup, removal of files not used during copy edits. * Update modules/ROOT/partials/misc/custom-dictionaries-path.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/misc/hunspell-dictionaries-path.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/misc/supported-application-servers.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/pages/support.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/pages/support.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/misc/supported-application-servers.adoc --------- Co-authored-by: Tim Dettrick <[email protected]>
1 parent 8f727d5 commit c9d4fa2

16 files changed

+78
-376
lines changed

modules/ROOT/nav.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,6 @@
140140
**** xref:configure-imageproxy-service.adoc[Image Proxy service settings]
141141
**** xref:configure-spelling-service.adoc[Spelling service settings]
142142
**** xref:self-hosting-hunspell.adoc[Spelling service - Using Hunspell dictionaries]
143-
**** xref:configure-logging-services.adoc[Activity logging]
144-
*** xref:introduction-to-premium-selfhosted-services.adoc[Server-side component installation without Docker]
145143
*** xref:troubleshoot-server.adoc[Troubleshoot server-side components]
146144
** Customizing the editor appearance
147145
*** xref:customize-ui.adoc[Customizing the UI]

modules/ROOT/pages/8.0-release-notes.adoc

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,22 @@ The fix ensures that the `s` element is now properly nested inside the font size
283283
[[deprecated]]
284284
== Deprecated
285285

286-
{productname} {release-version} includes the following deprecation<s>:
286+
{productname} {release-version} includes the following deprecations:
287+
288+
=== Java application server-based server components have been deprecated
289+
// #DOC-3231
290+
291+
{productname} {release-version} deprecates the Java application server-based deployment method for self-hosted services. Docker containers are now the **only** supported deployment method for self-hosted services. The Java `.war` files (`ephox-spelling.war`, `ephox-image-proxy.war`, `ephox-hyperlinking.war`) will be removed in a future release.
292+
293+
For information about setting up containerized server-side components using Docker containers, see: xref:bundle-intro-setup.adoc[Introduction and initial setup for containerized server-side services from the premium self-hosted bundles]
294+
295+
=== Docker container services
296+
297+
* Enhanced Media Embed and Link Checker service, see: xref:individual-hyperlinking-container.adoc[Deploy the {productname} hyperlinking server-side component using Docker].
298+
* Image Editing and Export image proxy service, see: xref:individual-image-proxy-container.adoc[Deploy the {productname} image proxy server-side component using Docker].
299+
* Spell Checker service, see: xref:individual-spelling-container.adoc[Deploy the {productname} spelling service server-side component using Docker].
300+
* Export to PDF service, see: xref:individual-export-to-pdf-on-premises.adoc[Deploy the {productname} Export to PDF service server-side component using Docker].
301+
* Import from Word and Export to Word services, see: xref:individual-import-from-word-and-export-to-word-on-premises.adoc[Deploy the {productname} Import from Word and Export to Word service server-side component using Docker].
287302

288303
// === The `<plugin>` configuration property, `<name>`, has been deprecated
289304
// #TINY-vwxyz1

modules/ROOT/pages/configure-logging-services.adoc

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

modules/ROOT/pages/introduction-to-mediaembed.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ include::partial$configuration/mediaembed_max_width.adoc[leveloffset=+1]
7373

7474
== Downloading Enhanced Media Embed plugin
7575

76-
A link:{pricingpage}/[{enterpriseversion} subscription] includes the ability to download and install the *Media Embed* plugin and a *WAR* file to access the service backend. Please follow these xref:introduction-to-premium-selfhosted-services.adoc#set-up-editor-client-instances-to-use-the-server-side-functionality[instructions] to configure the *WAR* file.
76+
A link:{pricingpage}/[{enterpriseversion} subscription] includes the ability to pull down the Docker image for the *Media Embed* plugin. For more information on how to deploy the *Media Embed* plugin, please see the xref:individual-hyperlinking-container.adoc[Deploy the {productname} hyperlinking server-side component using Docker] guide.

modules/ROOT/pages/introduction-to-premium-selfhosted-services.adoc

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

modules/ROOT/pages/introduction-to-tiny-spellchecker.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ tinymce.init({
3737

3838
To enable the {productname} Enterprise Spellchecking plugin, add `+tinymcespellchecker+` to the `+plugins+` list.
3939

40-
For information on installing the server-side component for spell checking, please see the xref:introduction-to-premium-selfhosted-services.adoc[server-side component installation guide].
40+
For information on installing the server-side component for spell checking, please see the xref:individual-spelling-container.adoc[Deploy the {productname} spelling service server-side component using Docker].
4141

4242
=== Example: TinyMCE Self-hosted Installation
4343

0 commit comments

Comments
 (0)