From 39e13d067b9c654fdd772bf9e922438be0010748 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Mon, 14 Oct 2024 16:43:43 +1000 Subject: [PATCH] DOC-2507_v6: Remove yeoman generator from tinymce-docs. --- modules/ROOT/nav.adoc | 1 - modules/ROOT/pages/creating-a-plugin.adoc | 4 -- modules/ROOT/pages/how-to-guides.adoc | 44 ++++++-------- modules/ROOT/pages/yeoman-generator.adoc | 74 ----------------------- 4 files changed, 19 insertions(+), 104 deletions(-) delete mode 100644 modules/ROOT/pages/yeoman-generator.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 790eafcc1d..81c9c89786 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -183,7 +183,6 @@ *** xref:shortcuts.adoc[Keyboard Shortcuts] *** Creating custom plugins **** xref:creating-a-plugin.adoc[Create a plugin] -**** xref:yeoman-generator.adoc[Yeoman generator] *** xref:editor-command-identifiers.adoc[Available Commands] *** xref:events.adoc[Available Events] *** xref:editor-icon-identifiers.adoc[Available Icons] diff --git a/modules/ROOT/pages/creating-a-plugin.adoc b/modules/ROOT/pages/creating-a-plugin.adoc index e23ed3d64c..a738b15d4c 100644 --- a/modules/ROOT/pages/creating-a-plugin.adoc +++ b/modules/ROOT/pages/creating-a-plugin.adoc @@ -12,10 +12,6 @@ To be recognized as a plugin by {productname}, the code for a custom plugin must {productname} does not require any special file structure or tooling apart from these requirements, so custom plugins can be developed using most frameworks and tools. -=== Yeoman Generator - -{companyname} maintains a xref:yeoman-generator.adoc[Yeoman generator] to assist with creating plugins for {productname}. The Yeoman Generator will create the files and boilerplate code required for a custom plugin, and sets up some helpful commands. - == Registering a custom plugin with {productname} Register a custom plugin with {productname} using the PluginManager. `+PluginManager.add()+` takes a string for the plugin identifier and a function that contains the code for initializing the plugin. diff --git a/modules/ROOT/pages/how-to-guides.adoc b/modules/ROOT/pages/how-to-guides.adoc index 008391c06b..ff8ed1ad9b 100644 --- a/modules/ROOT/pages/how-to-guides.adoc +++ b/modules/ROOT/pages/how-to-guides.adoc @@ -4,112 +4,106 @@ :type: folder // 2 Columns, both asciidoc -[cols=2*a] +[cols="1,1"] |=== -| +a| [.lead] xref:accessibility.adoc[Accessibility] Learn how {productname} works with screen readers and how screen readers work with {productname}. -| +a| [.lead] xref:security.adoc[Security] Security information for {productname}. -| +a| [.lead] xref:creating-a-skin.adoc[Create a skin] Introducing skin creation. -| +a| [.lead] xref:creating-an-icon-pack.adoc[Create an icon pack] Introducing icon pack creation. -| +a| [.lead] xref:creating-a-plugin.adoc[Create a plugin] Introducing plugin creation, with an example. -| +a| [.lead] xref:annotations.adoc[Annotations] {productname} Annotations provides the ability to describe particular features or add general information to a... -| -[.lead] -xref:yeoman-generator.adoc[Yeoman generator] - -How to use the Yeoman generator to bootstrap a new {productname} plugin - -| +a| [.lead] xref:creating-custom-notifications.adoc[Create custom notifications] Learn how to make custom notifications. -| +a| [.lead] xref:php-upload-handler.adoc[PHP image upload handler] A server-side upload handler PHP script. -| +a| [.lead] xref:available-menu-items.adoc[Available Menu Items] Complete list of menu items available for the menu bar and context menus. -| +a| [.lead] xref:available-toolbar-buttons.adoc[Available Toolbar Buttons] Complete list of toolbar buttons available for the toolbar and quick toolbars. -| +a| [.lead] xref:editor-command-identifiers.adoc[Available Commands] Complete list of editor commands. -| +a| [.lead] xref:editor-icon-identifiers.adoc[Available Icons] Complete list of icon identifiers. -| +a| [.lead] xref:editor-context-menu-identifiers.adoc[Available Context Menu Items] Complete list of available context menu sections. -| +a| [.lead] xref:events.adoc[Available Events] List of common editor events -| +a| [.lead] xref:keyboard-shortcuts.adoc[Keyboard shortcuts] Complete list of keyboard shortcuts. -| +a| [.lead] xref:introduction-to-bundling-tinymce.adoc[Bundling {productname}] Bundling {productname} with Webpack, rollup.js, or Browserify. -| +a| [.lead] xref:generate-rsa-key-pairs.adoc[Generate public key pairs] @@ -117,5 +111,5 @@ Instructions on how to generate private/public key pairs for the Tiny Cloud // Empty cell to even out rows // | - +a| |=== \ No newline at end of file diff --git a/modules/ROOT/pages/yeoman-generator.adoc b/modules/ROOT/pages/yeoman-generator.adoc deleted file mode 100644 index dee7577fe6..0000000000 --- a/modules/ROOT/pages/yeoman-generator.adoc +++ /dev/null @@ -1,74 +0,0 @@ -= TinyMCE plugin Yeoman generator -:navtitle: Yeoman generator -:description_short: How to use the Yeoman generator to bootstrap a new TinyMCE plugin -:description: How to use the Yeoman generator to bootstrap a new TinyMCE plugin using ES2015/Babel or TypeScript. -:keywords: webpack, yeoman, generator, plugin, tinymce - -{companyname} maintains a xref:yeoman-generator.adoc[Yeoman generator] to assist with creating plugins for {productname}. The Yeoman Generator will create the files and boilerplate code required for a custom plugin, and sets up some helpful commands. - -== Install the generator - -The plugin generator is built with the project scaffolding tool http://yeoman.io/[Yeoman]. To get started install both `+yo+` (the yeoman command) and the generator with the following command: - -[source,sh] ----- -npm install --global yo generator-tinymce ----- - -Wait for the install to finish. - -== Run the generator - -Start the generator with the following command: - -[source,sh] ----- -yo tinymce ----- - -You will then be guided through these questions: - -. *Plugin name:* The name of the plugin. -. *Plugin description (optional):* An optional description of the plugin. -. *Initialize git repo?* Here you can skip the creation of a new repository for the plugin. -. *What’s your name?* For license. -. *Your email (optional):* For license. -. *Your website (optional):* For license. -. *Which license do you want to use?* Choose the license for the plugin. - -Yeoman installs the needed dependencies, and the project is bootstrapped and ready. `+cd+` into the plugin directory and run the following command to start the auto-reloading development server: - -[source,sh] ----- -npm start ----- - -== Create distribution ready build - -Run the following command once you have completed development of the plugin: - -[source,sh] ----- -yarn build ----- - -A `+dist+` directory will be created, containing a sub-directory with the same name as the plugin. The sub-directory will contain the following files: - -* `+plugin.js+` - unminified plugin bundle -* `+plugin.min.js+` - minified and uglified plugin bundle -* `+CHANGELOG.txt+` - the text file containing your changes -* `+LICENSE.txt+` - the text file containing your license -* `+version.txt+` - the text file containing the version of your plugin - -For example, `+yarn build+` will generate the following output for a plugin named `+my_plugin+`: - -[source,sh] ----- -dist/ -└── my_plugin/ - ├── CHANGELOG.txt - ├── LICENSE.txt - ├── plugin.js - ├── plugin.min.js - └── version.txt -----