-
Notifications
You must be signed in to change notification settings - Fork 220
DOC-3517: Clarify service vs plugin distinction in on-premises service docs #4159
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
Open
kemister85
wants to merge
1
commit into
tinymce/8
Choose a base branch
from
hotfix/8/DOC-3517
base: tinymce/8
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+39
−30
Open
Changes from all commits
Commits
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 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
4 changes: 2 additions & 2 deletions
4
modules/ROOT/pages/individual-import-from-word-and-export-to-word-on-premises.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
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
8 changes: 4 additions & 4 deletions
8
...es/ROOT/partials/docker/hyperlinking-service/hyperlinking-service-overview.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,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 link validation and rich media resolution capabilities. It runs on-premises within the host infrastructure and powers the link:https://www.tiny.cloud/tinymce/features/link-checker/[{linkcheckerplugin}^] and link:https://www.tiny.cloud/tinymce/features/enhanced-media-embed/[{mediaembedplugin}^] plugins 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[] | ||
6 changes: 3 additions & 3 deletions
6
modules/ROOT/partials/docker/image-proxy-service/image-proxy-service-overview.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,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 processes and serves images 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 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[] |
8 changes: 4 additions & 4 deletions
8
modules/ROOT/partials/docker/spelling-service/spelling-service-overview.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,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[] |
11 changes: 7 additions & 4 deletions
11
...ials/individually-licensed-components/export-to-pdf/export-to-pdf-overview.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,15 +1,18 @@ | ||
| [[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] | ||
| ==== | ||
| To use {productname} 8.4.0 or newer with the Export to PDF plugin, the on-premises Docker image must support the v2 API (`/v2/convert/html-pdf`). Use the latest image or a v2-compatible version. See the link:https://registry.containers.tiny.cloud/api/changelogs/pdf-converter-tiny[changelog^] for version details. | ||
| ==== | ||
|
|
||
| A valid license key is required in order to install {pluginname} Converter On-Premises. You will also need an access token to access the {companyname} Cloud Docker registry and pull the Docker image. | ||
| A valid license key is required to install the {pluginname} service on-premises. An access token is also needed to access the {companyname} Cloud Docker registry and pull the Docker image. | ||
|
|
||
| To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial license key and Docker access token. | ||
| To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial 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. |
16 changes: 11 additions & 5 deletions
16
...nd-export-to-word/import-from-word-and-export-to-word-overview-on-premises.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,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: | ||
|
|
||
| A valid license key is needed in order to install {pluginname} On-Premises. You will also need an access token to access the Tiny Cloud Docker registry and pull the Docker image. | ||
| * 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. | ||
|
|
||
| To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial license key and Docker access token. | ||
| 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. | ||
|
|
||
| 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. | ||
| A valid license key is required to install the {pluginname} service on-premises. An access token is also needed to access the {companyname} Cloud Docker registry and pull the Docker image. | ||
|
|
||
| To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial 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. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"and rich media resolution capabilities" - does it?? either this is news to me, or I'm confused by what you mean by this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
asked in Slack, because the questions spanned a couple pages