Browse Source

DOC-127: add Tiny5 cloud delivery info and 4 -> 5 change over details

pull/905/head
Mike Chau 7 years ago
parent
commit
4604b1b967
  1. 9
      _data/nav.yml
  2. 11
      cloud-deployment-guide/coming-soon.md
  3. 2
      cloud-deployment-guide/editor-and-features.md
  4. 106
      cloud-deployment-guide/editor-plugin-version.md
  5. 2
      cloud-deployment-guide/index.md
  6. 17
      migration-from-4x.md

9
_data/nav.yml

@ -20,11 +20,10 @@
- url: "cloud-deployment-guide"
pages:
- url: "coming-soon"
# - url: "editor-and-features"
# - url: "features-only"
# - url: "editor-plugin-version"
# - url: "plugin-editor-version-compatibility"
- url: "editor-and-features"
- url: "features-only"
- url: "editor-plugin-version"
- url: "plugin-editor-version-compatibility"
- url: "demo"
pages:

11
cloud-deployment-guide/coming-soon.md

@ -1,11 +0,0 @@
---
layout: default
title: Cloud Deployment of Editor & Plugins
description_short: Learn how to set up the TinyMCE editor via the Cloud, or migrate from a self-hosted environment.
description: Run Tiny Cloud in less than 5 minutes.
keywords: tinymce cloud script textarea apiKey
---
Tiny Cloud is the easiest way to integrate TinyMCE and upgrade to premium plugins.
This section is under revision and will be available soon.

2
cloud-deployment-guide/editor-and-features.md

@ -21,7 +21,7 @@ Insert the TinyMCE editor code into the application to load TinyMCE for the firs
The following example adds a script tag into the application that inserts the code. Use the `<head>` of the page on a web page.
```js
<script src="{{ site.cdnurl }}?apiKey=your_API_key"></script>
<script src="https://cloud.tinymce.com/5-stable/tinymce.min.js?apiKey=your_API_key"></script>
```
### Step 2: Load, customize and interact with TinyMCE

106
cloud-deployment-guide/editor-plugin-version.md

@ -10,46 +10,20 @@ keywords: tinymce cloud script textarea apiKey
Use the URL provided to specify the TinyMCE version when deploying via Tiny Cloud. Refer to [TinyMCE editor via the Tiny Cloud]({{ site.baseurl }}/cloud-deployment-guide/editor-and-features) for more information.
Please note as Tinymce 5 is currently under development,
The traditional ```https://cloud.tinymce.com/stable/tinymce.min.js``` is currently serving the latest Tinymce 4x. From February 4, 2019, at 2pm Pacific Standard Time (GMT-8). The '/stable/' link will default to serving Tinymce 5.
The following example is the default for loading TinyMCE via Tiny Cloud:
```js
<script src="{{ site.cdnurl }}?apiKey=your_API_key"></script>
<script src="https://cloud.tinymce.com/5-stable/tinymce.min.js?apiKey=your_API_key"></script>
```
The `stable` in this URL specifies the latest, and quality assured release of TinyMCE. This value can be customized to any [supported versions here](https://cloud.tinymce.com/versions/tiny).
The `stable` in this URL specifies the latest, and quality assured release of TinyMCE.
### Selecting specific version numbers
*Major*, *Major.Minor*, or *Major.Minor.Patch* version numbers can all be specified. The latest *Major.Minor* or *Major.Minor.Patch* patch versions are released by default if the *Major.Minor* or *Major.Minor.Patch* versions are not present.
##### Example
Major version number (e.g. "5").
The following loads TinyMCE *5.latest.latest*:
```js
<script src="https://cloud.tinymce.com/5/tinymce.min.js?apiKey=your_API_key"></script>
```
##### Example
Major.Minor version number (e.g. "4.3").
The following loads TinyMCE *4.3.latest*:
```js
<script src="https://cloud.tinymce.com/4.3/tinymce.min.js?apiKey=your_API_key"></script>
```
##### Example
Major.Minor.Patch version number (e.g. "4.3.2").
The following loads TinyMCE *4.3.2*:
```js
<script src="https://cloud.tinymce.com/4.3.2/tinymce.min.js?apiKey=your_API_key"></script>
```
A**HTTP 404** error is returned when a version does not exist.
Support for requesting specific versions of TinyMCE 5 will be available after TinyMCE 5 RC becomes stable. It should work in a similar way as Tinymce 4. In the meantime, there are 3 release channels available, see the section below.
### dev, testing, and stable releases
@ -59,32 +33,32 @@ These channels are updated automatically and provide the latest TinyMCE version
#### dev release channel
This channel deploys the absolute latest version of TinyMCE as documented in [TinyMCE changelog]({{ site.baseurl }}/changelog/). The current version of TinyMCE available through the `dev` channel [can be found at here](https://cloud.tinymce.com/dev/version.txt).
This channel deploys the absolute latest version of TinyMCE as documented in [TinyMCE changelog]({{ site.baseurl }}/changelog/). The current version of TinyMCE available through the `dev` channel [can be found at here](https://cloud.tinymce.com/5-dev/version.txt).
##### Example
```js
<script src="https://cloud.tinymce.com/dev/tinymce.min.js?apiKey=your_API_key"></script>
<script src="https://cloud.tinymce.com/5-dev/tinymce.min.js?apiKey=your_API_key"></script>
```
#### testing release channel
This channel deploys the current release candidate for the `stable` channel. The TinyMCE release candidate is undergoing quality assurance. The current version of TinyMCE available through the `testing` channel [can be found at here](https://cloud.tinymce.com/testing/version.txt).
This channel deploys the current release candidate for the `stable` channel. The TinyMCE release candidate is undergoing quality assurance. The current version of TinyMCE available through the `testing` channel [can be found at here](https://cloud.tinymce.com/5-testing/version.txt).
##### Example
```js
<script src="https://cloud.tinymce.com/testing/tinymce.min.js?apiKey=your_API_key"></script>
<script src="https://cloud.tinymce.com/5-testing/tinymce.min.js?apiKey=your_API_key"></script>
```
#### stable release channel
This channel deploys the latest release of TinyMCE that has passed our quality assurance process. The current version of TinyMCE available through the `stable` channel [can be found here](https://cloud.tinymce.com/stable/version.txt).
This channel deploys the latest release of TinyMCE that has passed our quality assurance process. The current version of TinyMCE available through the `stable` channel [can be found here](https://cloud.tinymce.com/5-stable/version.txt).
##### Example
```js
<script src="{{ site.cdnurl }}?apiKey=your_API_key"></script>
<script src="https://cloud.tinymce.com/5-stable/tinymce.min.js?apiKey=your_API_key"></script>
```
## Specifying the version of features/plugins deployed from Tiny Cloud
@ -231,57 +205,5 @@ The "SDK" version lets the TinyMCE Plugin Manager know that you're not using Tin
### Featuring declared editor and plugin versions
The following example loads:
* TinyMCE 4.5.0
* PowerPaste version 2.1.8
* Advanced Code Editor 1.0.2
```js
<html>
<head>
<script src="https://cloud.tinymce.com/4.5.0/tinymce.min.js?apiKey=your_API_key&powerpaste=2.1.8&advcode=1.0.2"></script>
</head>
<body>
<textarea><p>test textarea</p></textarea>
<script>
tinymce.init({
selector: 'textarea',
height: 500,
plugins: [
'advlist autolink lists link image charmap print preview hr anchor pagebreak',
'tinymcespellchecker']
});
</script>
</body>
<html>
```
### Featuring a combination of self-hosted and Tiny Cloud features
The following example loads:
* TinyMCE self-hosted installation
* PowerPaste version 2.1.8 from Tiny Cloud
* Advanced Code Editor self-hosted installation
```js
<html>
<head>
<script src="https://cloud.tinymce.com/stable/plugins.min.js?apiKey=your_API_key&powerpaste=2.1.8&advcode=sdk"></script>
</head>
<body>
<textarea><p>test textarea</p></textarea>
<script>
tinymce.init({
selector: 'textarea',
height: 500,
plugins: [
'advlist autolink lists link image charmap print preview hr anchor pagebreak',
'tinymcespellchecker']
});
</script>
</body>
<html>
```
Support for requesting specific versions of TinyMCE 5 and plugin versions will be available after TinyMCE 5 RC becomes stable.
The process will work similar to Tinymce 4. For now only the latest version is available via cloud.

2
cloud-deployment-guide/index.md

@ -8,5 +8,3 @@ type: folder
{% assign links = site.data.nav[2].pages %}
{% include index.html links=links %}
Coming soon

17
migration-from-4x.md

@ -14,6 +14,23 @@ This chapter describes the migration process and workarounds for customers using
## Editor-Core
### Cloud Delivery
To serve TinyMCE 5 from the cloud, include this in your html page:
```js
<script src="https://cloud.tinymce.com/5-stable/tinymce.min.js?apiKey=your_API_key"></script>
```
To serve the latest nightlies and testing builds refer to the [cloud deployment guide](/cloud-deployment-guide/editor-and-features/)
On February 4, 2019, at 2 pm Pacific Standard Time (GMT-8), TinyMCE 5 will be deployed to the cloud stable channel. This means that if you are running TinyMCE from the stable channel it will automatically be upgraded from version 4 to version 5.
Current TinyMCE 4 Cloud users, who are using the ```/stable/``` channel and would like to continue using TinyMCE 4, should update their script tags to version lock TinyMCE 4
```js
<script src="https://cloud.tinymce.com/4/tinymce.min.js?apiKey=your_API_key"></script>
```
### Initialization
The initialization process of TinyMCE 5.0 is the same as TinyMCE 4.x. The bootstrap process and initialization events all remain the same. It still retains a familiar JSON structure. Some `init` configuration in the TinyMCE version 5.0 has been updated to simplify the configuration options, specifically the configuration items for [UI components]({{site.baseurl}}/ui-components/). Please see the [Quick start]({{site.baseurl}}/quick-start) section for more information on setup.

Loading…
Cancel
Save