DOC-3367: Add new bundling guide overview page.#3983
DOC-3367: Add new bundling guide overview page.#3983kemister85 wants to merge 4 commits intotinymce/8from
Conversation
kemister85
requested review from
a team,
jscasca,
kimwoodfield,
metricjs,
soritaheng and
tiny-ben-tran
and removed request for
a team
Co-authored-by: Sorita Heng <69398037+soritaheng@users.noreply.github.com>
Co-authored-by: Sorita Heng <69398037+soritaheng@users.noreply.github.com>
|
|
||
| == Required imports | ||
|
|
||
| include::partial$module-loading/bundling-required-components.adoc[] |
There was a problem hiding this comment.
Can't find the file, but there's a line that repeats itself:
A custom or premium icon pack to extend or override the default icons for toolbar buttons, including contextual toolbars. This can be a premium or custom icon pack.
There was a problem hiding this comment.
We do call it out super well further down, so it's a nitpick
| import 'tinymce/skins/ui/oxide/content.js'; | ||
|
|
||
| /* Content CSS for editor content styling */ | ||
| import 'tinymce/skins/content/default/content.js'; |
There was a problem hiding this comment.
Said in the section above that this isn't required, then put it in an example of required imports?
There was a problem hiding this comment.
Maybe we could say 'recommended imports' instead?
|
|
||
| Most plugins can be imported directly using their plugin code. The import path depends on whether the plugin is a community or premium plugin: | ||
|
|
||
| === Community plugins |
There was a problem hiding this comment.
I do wonder if it's worth mentioning somewhere in this page that we've mostly (entirely?) talking about pulling files from NPM? Like, it's implied but also... The premium example in particular won't make sense if you're thinking of using a bundle or something.
|
|
||
| Both syntaxes are supported, but this documentation uses ES6 module syntax in all examples. | ||
|
|
||
| == Required imports |
There was a problem hiding this comment.
Should we be listing the license key manager in here actually? It's only required if using a premium plugin, but. Still a requirement?
|
|
||
| * The `+advtable+` plugin requires the `+table+` plugin | ||
|
|
||
| Always import dependent plugins before the plugin that requires them. |
There was a problem hiding this comment.
We should probably mention where else to find this info, since we've framed this as an example and not a full list. Should advise to check the plugin's page I guess?
3 participants
Ticket: DOC-3367
Site: New: Bundling guide (page)
Summary
Adds a new bundling overview guide and improves bundling documentation consistency across the codebase.
Changes
New Files
modules/ROOT/pages/bundling-guide.adoc- New bundling overview page providing:include::partial$misc/bundling-guide-link.adoc[]to all core and premium plugins.Pre-checks:
feature/<version>/,hotfix/<version>/,staging/<version>/, orrelease/<version>/.modules/ROOT/nav.adochas been updated(if applicable).Review: