Skip to content

Commit bf4db89

Browse files
authored
DOC-3313_v2: Improve Developer Onboarding and fix broken partials for bundling pages and key architectural changes. (#3915)
* DOC-3313_v2: Improve Developer Onboarding and fix broken partials for bundling pages and key architectural changes. * DOC-3313_V2: Fix list syntax errors. * DOC-3313_v2: Remove Bower documentation due to deprication 2017 notice. * DOC-3313_v2: update wording from supported to supported integrations. * DOC-3313_v2: update working from framework to integration. * DOC-3313_V2: updating naming conventions. * DOC-3313_v2: add todo for missing bootstrap CDN link/script.
1 parent 1399eca commit bf4db89

33 files changed

+916
-304
lines changed

modules/ROOT/nav.adoc

Lines changed: 71 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,74 @@
11
* xref:getting-started.adoc[Getting started]
22
** xref:introduction-to-tinymce.adoc[Introduction to {productname}]
33
** xref:installation.adoc[Installation]
4-
*** Cloud
5-
**** xref:cloud-quick-start.adoc[Quick start]
6-
**** xref:react-cloud.adoc[React]
7-
**** xref:angular-cloud.adoc[Angular]
8-
**** xref:vue-cloud.adoc[Vue.js]
9-
**** xref:blazor-cloud.adoc[Blazor]
10-
**** xref:svelte-cloud.adoc[Svelte]
11-
**** xref:webcomponent-cloud.adoc[Web Component]
12-
**** xref:jquery-cloud.adoc[jQuery]
13-
**** xref:bootstrap-cloud.adoc[Bootstrap]
14-
**** xref:django-cloud.adoc[Django]
15-
**** xref:laravel-tiny-cloud.adoc[Laravel]
16-
**** xref:rails-cloud.adoc[Ruby on Rails]
17-
*** Self-hosted
18-
**** React
19-
***** xref:react-pm-host.adoc[Using a package manager with hosting]
20-
***** xref:react-pm-bundle.adoc[Using a package manager with bundling]
21-
***** xref:react-zip-host.adoc[Using a .zip package with hosting]
22-
***** xref:react-zip-bundle.adoc[Using a .zip package with bundling]
23-
**** Angular
24-
***** xref:angular-pm.adoc[Using a package manager]
25-
***** xref:angular-zip.adoc[Using a .zip package]
26-
**** Vue.js
27-
***** xref:vue-pm.adoc[Using a package manager]
28-
***** xref:vue-zip.adoc[Using a .zip package]
29-
**** Blazor
30-
***** xref:blazor-pm.adoc[Using a package manager]
31-
***** xref:blazor-zip.adoc[Using a .zip package]
32-
**** Svelte
33-
***** xref:svelte-pm.adoc[Using a package manager]
34-
***** xref:svelte-zip.adoc[Using a .zip package]
35-
**** Web Component
36-
***** xref:webcomponent-pm.adoc[Using a package manager]
37-
***** xref:webcomponent-zip.adoc[Using a .zip package]
38-
**** xref:swing.adoc[Java Swing]
39-
**** xref:shadow-dom.adoc[Shadow DOM]
40-
**** xref:jquery-pm.adoc[jQuery]
41-
**** xref:bootstrap-zip.adoc[Bootstrap]
42-
**** xref:django-zip.adoc[Django]
43-
**** xref:expressjs-pm.adoc[Node.js + Express]
44-
**** Laravel
45-
***** xref:laravel-composer-install.adoc[Using the Composer package]
46-
***** xref:laravel-zip-install.adoc[Using a .zip package]
47-
**** Ruby on Rails
48-
***** xref:rails-third-party.adoc[Using a package manager]
49-
***** xref:rails-zip.adoc[Using a .zip package]
50-
**** xref:wordpress.adoc[WordPress]
51-
**** xref:npm-projects.adoc[NPM projects]
52-
**** xref:php-projects.adoc[PHP projects]
53-
**** xref:dotnet-projects.adoc[.NET projects]
54-
**** xref:bower-projects.adoc[Bower projects]
55-
**** xref:zip-install.adoc[{productname} .zip deployments]
4+
*** xref:installation-cloud.adoc[Cloud]
5+
**** xref:cloud-quick-start.adoc[Quick start guide]
6+
**** Supported Integrations
7+
***** xref:react-cloud.adoc[React]
8+
***** xref:angular-cloud.adoc[Angular]
9+
***** xref:vue-cloud.adoc[Vue.js]
10+
***** xref:blazor-cloud.adoc[Blazor]
11+
***** xref:svelte-cloud.adoc[Svelte]
12+
***** xref:webcomponent-cloud.adoc[Web Component]
13+
***** xref:jquery-cloud.adoc[jQuery]
14+
**** Backend Integrations
15+
***** xref:django-cloud.adoc[Django]
16+
***** xref:laravel-tiny-cloud.adoc[Laravel]
17+
***** xref:rails-cloud.adoc[Ruby on Rails]
18+
**** Other Integrations
19+
***** xref:bootstrap-cloud.adoc[Bootstrap]
20+
*** xref:installation-self-hosted.adoc[Self-hosted]
21+
**** xref:npm-projects.adoc[Quick start guide]
22+
**** Supported Integrations
23+
***** React
24+
****** xref:react-pm-host.adoc[Using a package manager with hosting]
25+
****** xref:react-pm-bundle.adoc[Using a package manager with bundling]
26+
***** Angular
27+
****** xref:angular-pm.adoc[Using a package manager]
28+
***** Vue.js
29+
****** xref:vue-pm.adoc[Using a package manager]
30+
***** Blazor
31+
****** xref:blazor-pm.adoc[Using a package manager]
32+
***** Svelte
33+
****** xref:svelte-pm.adoc[Using a package manager]
34+
***** Web Component
35+
****** xref:webcomponent-pm.adoc[Using a package manager]
36+
***** xref:jquery-pm.adoc[jQuery]
37+
***** xref:swing.adoc[Java Swing]
38+
**** Backend Integrations
39+
***** Laravel
40+
****** xref:laravel-composer-install.adoc[Using the Composer package]
41+
***** Ruby on Rails
42+
****** xref:rails-third-party.adoc[Using a package manager]
43+
***** xref:expressjs-pm.adoc[Node.js + Express]
44+
**** Other Integrations
45+
***** xref:shadow-dom.adoc[Shadow DOM]
46+
***** xref:php-projects.adoc[PHP projects]
47+
***** xref:dotnet-projects.adoc[.NET projects]
48+
***** xref:wordpress.adoc[WordPress]
49+
*** xref:installation-zip.adoc[ZIP]
50+
**** xref:zip-install.adoc[Quick start guide]
51+
**** Supported Integrations
52+
***** React
53+
****** xref:react-zip-host.adoc[Using a .zip package with hosting]
54+
****** xref:react-zip-bundle.adoc[Using a .zip package with bundling]
55+
***** Angular
56+
****** xref:angular-zip.adoc[Using a .zip package]
57+
***** Vue.js
58+
****** xref:vue-zip.adoc[Using a .zip package]
59+
***** Blazor
60+
****** xref:blazor-zip.adoc[Using a .zip package]
61+
***** Svelte
62+
****** xref:svelte-zip.adoc[Using a .zip package]
63+
***** Web Component
64+
****** xref:webcomponent-zip.adoc[Using a .zip package]
65+
***** xref:swing.adoc[Java Swing]
66+
**** Backend Integrations
67+
***** xref:django-zip.adoc[Django]
68+
***** xref:laravel-zip-install.adoc[Laravel]
69+
***** xref:rails-zip.adoc[Ruby on Rails]
70+
**** Other Integrations
71+
***** xref:bootstrap-zip.adoc[Bootstrap]
5672
** xref:upgrading.adoc[Upgrading {productname}]
5773
* xref:how-to-guides.adoc[How-to guides]
5874
** Learn the basics
@@ -63,64 +79,6 @@
6379
*** xref:spell-checking.adoc[Spell checking]
6480
*** xref:editor-content-css.adoc[CSS for rendering content]
6581
*** xref:userlookup.adoc[Using the UserLookup API]
66-
** Environment setup guides
67-
*** React framework
68-
**** xref:react-cloud.adoc[Using the Tiny Cloud]
69-
**** xref:react-pm-host.adoc[Using a package manager with hosting]
70-
**** xref:react-pm-bundle.adoc[Using a package manager with bundling]
71-
**** xref:react-zip-host.adoc[Using a .zip package with hosting]
72-
**** xref:react-zip-bundle.adoc[Using a .zip package with bundling]
73-
**** xref:react-ref.adoc[Technical reference]
74-
*** Angular framework
75-
**** xref:angular-cloud.adoc[Using the Tiny Cloud]
76-
**** xref:angular-pm.adoc[Using a package manager]
77-
**** xref:angular-zip.adoc[Using a .zip package]
78-
**** xref:angular-ref.adoc[Technical reference]
79-
*** Vue.js framework
80-
**** xref:vue-cloud.adoc[Using the Tiny Cloud]
81-
**** xref:vue-pm.adoc[Using a package manager]
82-
**** xref:vue-zip.adoc[Using a .zip package]
83-
**** xref:vue-ref.adoc[Technical reference]
84-
*** Blazor framework
85-
**** xref:blazor-cloud.adoc[Using the Tiny Cloud]
86-
**** xref:blazor-pm.adoc[Using a package manager]
87-
**** xref:blazor-zip.adoc[Using a .zip package]
88-
**** xref:blazor-ref.adoc[Technical reference]
89-
*** Svelte framework
90-
**** xref:svelte-cloud.adoc[Using the Tiny Cloud]
91-
**** xref:svelte-pm.adoc[Using a package manager]
92-
**** xref:svelte-zip.adoc[Using a .zip package]
93-
**** xref:svelte-ref.adoc[Technical reference]
94-
*** Web Component
95-
**** xref:webcomponent-cloud.adoc[Using the Tiny Cloud]
96-
**** xref:webcomponent-pm.adoc[Using a package manager]
97-
**** xref:webcomponent-zip.adoc[Using a .zip package]
98-
**** xref:webcomponent-ref.adoc[Technical reference]
99-
*** xref:swing.adoc[Java Swing]
100-
*** jQuery
101-
**** xref:jquery-cloud.adoc[Using the Tiny Cloud]
102-
**** xref:jquery-pm.adoc[Using a package manager]
103-
*** Bootstrap framework
104-
**** xref:bootstrap-cloud.adoc[Using the Tiny Cloud]
105-
**** xref:bootstrap-zip.adoc[Using a .zip package]
106-
*** Django framework
107-
**** xref:django-cloud.adoc[Using the Tiny Cloud]
108-
**** xref:django-zip.adoc[Using a .zip package]
109-
*** xref:expressjs-pm.adoc[Node.js + Express]
110-
*** Laravel framework
111-
**** xref:laravel-tiny-cloud.adoc[Using the Tiny Cloud]
112-
**** xref:laravel-composer-install.adoc[Using the Composer package]
113-
**** xref:laravel-zip-install.adoc[Using a .zip package]
114-
*** Ruby on Rails framework
115-
**** xref:rails-cloud.adoc[Using the Tiny Cloud]
116-
**** xref:rails-third-party.adoc[Using a package manager]
117-
**** xref:rails-zip.adoc[Using a .zip package]
118-
*** xref:wordpress.adoc[WordPress]
119-
*** xref:npm-projects.adoc[NPM projects]
120-
*** xref:php-projects.adoc[PHP projects]
121-
*** xref:dotnet-projects.adoc[.NET projects]
122-
*** xref:bower-projects.adoc[Bower projects]
123-
*** xref:zip-install.adoc[{productname} .zip deployments]
12482
** xref:cloud-deployment-guide.adoc[Cloud deployment guide]
12583
*** xref:editor-and-features.adoc[Cloud deployment of editor & plugins]
12684
*** xref:features-only.adoc[Cloud deployment of plugins Only]
@@ -328,13 +286,13 @@
328286
***** xref:import-from-word-with-jwt-authentication-nodejs.adoc[Node.js]
329287
***** xref:import-from-word-with-jwt-authentication-php.adoc[PHP]
330288
*** xref:editimage.adoc[Image Editing]
289+
*** xref:uploadcare.adoc[Media Optimizer]
290+
**** xref:uploadcare-image.adoc[Image]
291+
**** xref:uploadcare-video.adoc[Video]
331292
*** xref:inline-css.adoc[Inline CSS]
332293
*** xref:linkchecker.adoc[Link Checker]
333294
*** xref:math.adoc[Math]
334295
*** xref:markdown.adoc[Markdown]
335-
*** xref:uploadcare.adoc[Media Optimizer]
336-
**** xref:uploadcare-image.adoc[Image]
337-
**** xref:uploadcare-video.adoc[Video]
338296
*** xref:mentions.adoc[Mentions]
339297
*** xref:mergetags.adoc[Merge Tags]
340298
*** xref:moxiemanager.adoc[MoxieManager]

modules/ROOT/pages/bower-projects.adoc

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

modules/ROOT/pages/browserify-cjs-npm.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= Bundling an npm version of {productname} with CommonJS and Browserify
1+
= Bundling an NPM version of {productname} with CommonJS and Browserify
22
:navtitle: CommonJS and npm
3-
:description_short: Bundling an npm version of TinyMCE in a project using CommonJS and Browserify
4-
:description: Bundling an npm version of TinyMCE in a project using CommonJS and Browserify
3+
:description_short: Bundling an NPM version of TinyMCE in a project using CommonJS and Browserify
4+
:description: Bundling an NPM version of TinyMCE in a project using CommonJS and Browserify
55
:keywords: browserify, commonjs, cjs, npm, modules, tinymce
66
:installtype: an npm
77
:bundler: https://browserify.org/[Browserify]
Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,46 @@
1-
= Quick start
2-
:navtitle: Quick start
1+
= Quick start: {productname} with {cloudname}
2+
:navtitle: Quick start: Cloud
33
:description_short: Setup a basic {productname} {productmajorversion} editor using the {cloudname}.
44
:description: Get an instance of {productname} {productmajorversion} up and running using the {cloudname}.
55
:keywords: tinymce, script, textarea
66
:productSource: cloud
77

8-
include::partial$install/basic-quickstart-base.adoc[]
8+
== Install {productname} using the {cloudname}
99

10-
include::partial$misc/admon-account-creation-and-social-option.adoc[]
10+
{productname} {productmajorversion} is a powerful and flexible rich text editor that can be embedded in web applications. This quick start covers how to add a {productname} editor to a web page using the {cloudname}.
11+
12+
include::partial$misc/admon-account-creation-and-social-option.adoc[]
13+
14+
== Include the {productname} script
15+
16+
Include the following line of code in the `+<head>+` of an HTML page:
17+
18+
[source,html,subs="attributes+"]
19+
----
20+
<script src="{cdnurl}" referrerpolicy="origin" crossorigin="anonymous"></script>
21+
----
22+
23+
== Initialize {productname} as part of a web form
24+
25+
include::partial$install/initialize-editor-cloud.adoc[]
26+
27+
Adding this content to an HTML file and opening it in a web browser will load a {productname} editor, such as:
28+
29+
liveDemo::default[]
30+
31+
== Update the "no-api-key" placeholder with your API key
32+
33+
To remove the notice:
34+
35+
[WARNING]
36+
====
37+
**This domain is not registered with {cloudname}. Please see the quick start guide or create an account.**
38+
====
39+
40+
Update the `+no-api-key+` placeholder in the source script (`+<script src=...+`) with your {cloudname} API key, which is created when signing up to the link:{accountsignup}/[{cloudname}].
41+
42+
Signing up for a {cloudname} API key will also provide a trial of the xref:plugins.adoc#premium-plugins[Premium Plugins].
43+
44+
include::partial$install/save-content.adoc[]
45+
46+
include::partial$misc/quickstart-next-steps.adoc[]

modules/ROOT/pages/dotnet-projects.adoc

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,49 @@
22
:navtitle: .NET projects
33
:description: Learn how to install {productname} from NuGet.
44
:keywords: nuget .net install
5-
:productSource: nuget
65

7-
include::partial$install/basic-quickstart-base.adoc[]
6+
== Install {productname} using NuGet
7+
8+
{productname} {productmajorversion} is a powerful and flexible rich text editor that can be embedded in web applications. This quick start covers how to add a {productname} editor to a web page using NuGet.
9+
10+
To add {productname} to a .NET project, run the following on a command line:
11+
12+
* Using the NuGet package manager console, run the following:
13+
+
14+
[source,sh]
15+
----
16+
Install-Package {productname}
17+
----
18+
19+
* Using the `+dotnet+` CLI, run the following:
20+
+
21+
[source,sh]
22+
----
23+
dotnet add package {productname}
24+
----
25+
26+
Ensure the `+tinymce+` directory containing the `+tinymce.min.js+` file is accessible for the target page or application by either:
27+
28+
* Using a webserver route, or
29+
* Copying the `+tinymce+` directory to a public folder using a build tool.
30+
31+
== Include the {productname} script
32+
33+
Include the following line of code in the `+<head>+` of an HTML page:
34+
35+
[source,html,subs="attributes+"]
36+
----
37+
<script src="/path/or/uri/to/tinymce.min.js" referrerpolicy="origin" crossorigin="anonymous"></script>
38+
----
39+
40+
== Initialize {productname} as part of a web form
41+
42+
include::partial$install/initialize-editor-self-hosted.adoc[]
43+
44+
Adding this content to an HTML file and opening it in a web browser will load a {productname} editor, such as:
45+
46+
liveDemo::default[]
47+
48+
include::partial$install/save-content.adoc[]
49+
50+
include::partial$misc/quickstart-next-steps.adoc[]

0 commit comments

Comments
 (0)