Move lost grapesjs documentation to docs, small improves #43
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
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
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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,74 @@ | ||||||
| GrapesJS Builder | ||||||
| ################ | ||||||
|
|
||||||
| Currently, Mautic uses the GrapesJS Builder for Emails and Landing pages. | ||||||
|
|
||||||
| Setup | ||||||
| ***** | ||||||
|
|
||||||
| .. code-block:: BASH | ||||||
|
|
||||||
| npm install | ||||||
|
|
||||||
| .. vale off | ||||||
|
|
||||||
| Configure Babel, ESLint, Prettier | ||||||
| ================================= | ||||||
|
|
||||||
| .. vale on | ||||||
|
|
||||||
| Use the template files provided. For example .eslintrc.temp | ||||||
|
Member
There was a problem hiding this comment. And do what with them? Can we be a bit more helpful here? Even if we point people out to documentation on external sites, it would be helpful to folks who might not know what to do with the template files. |
||||||
|
|
||||||
| How to test standalone | ||||||
|
Member
There was a problem hiding this comment. What does it mean to test standalone? This isn't very clear. Perhaps we could explain why you would do this and what it would allow you to do? |
||||||
| ********************** | ||||||
|
|
||||||
| .. code-block:: BASH | ||||||
|
|
||||||
| npm run start-helloWorld | ||||||
|
Member
There was a problem hiding this comment. As above I think we need to be clear - are we in Mautic's root? In the plugin folder? What is the difference between the two commands and why might you use one rather than the other? |
||||||
| or | ||||||
| npm run start-mautic | ||||||
|
|
||||||
| In order for ``start-mautic`` to work, a running DDEV container has to be present. | ||||||
|
|
||||||
| If you are using another development environment you need to update some paths in ``Demo/mautic/index.html``. | ||||||
|
Member
There was a problem hiding this comment. Let's be kind and give some examples here? You can use code blocks to include code samples. |
||||||
|
|
||||||
| How to build for production | ||||||
| *************************** | ||||||
|
|
||||||
| .. code-block:: BASH | ||||||
|
|
||||||
| npm run build | ||||||
|
Member
There was a problem hiding this comment. As above, state where to run this. |
||||||
|
|
||||||
| Code architecture | ||||||
| ***************** | ||||||
|
|
||||||
| There is PHP and the JavaScript code. | ||||||
|
|
||||||
| All the JavaScript code lives in the Assets/library folder. This handles the UI of the builder. | ||||||
|
|
||||||
| In addition to the code in this repository, there is also the :xref:`GrapesJS Preset`. | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
We aren't referring to a separate repo at this time. |
||||||
|
|
||||||
| This repository handles the basic Mautic specific code. The general idea is that this preset repository is a base for various Mautic builder Plugins. | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| E.g one where the Rich Text Editor is CKEditor, or where there is some very customer or industry specific features. | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ``` | ||||||
| - It's a pack of configurable feautures: | ||||||
| - Adds the function to edit source code | ||||||
| - Extends the original image and add a confirm dialog before removing it | ||||||
| - Add the option to hide/show the Layers Manager | ||||||
| - Add the option to enable/disable the import code button | ||||||
| - Moves the Settings panel inside Style Manager panel | ||||||
| - Opens the Block Manager at launch | ||||||
| - Add Dynamic Content Block for HTML used in Mautic | ||||||
| ``` | ||||||
|
|
||||||
|
Member
There was a problem hiding this comment. I think that we need to add here some instructions on how to roll your own custom preset. For example how to create a fork of the Mautic preset, and how to ship it with your own Mautic instance. I think that a few people do that already so hopefully we can get that documented. I would also like to see some basic examples of: How to create a new block These could link out to external documentation or be included here as our own docs. |
||||||
| Issues | ||||||
| ****** | ||||||
|
|
||||||
| Report issues in the main Mautic repository, labelled as :xref:`GrapesJS issue queue` | ||||||
|
|
||||||
| PRs | ||||||
| *** | ||||||
|
|
||||||
| Contributions to improve the GrapesJS Plugin happen in the main Mautic repository as :xref:`GitHub PRs` | ||||||
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
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
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| from . import link | ||
|
|
||
| link_name = "GitHub PRs" | ||
| link_text = "GitHub PRs" | ||
| link_url = "https://github.com/mautic/mautic/pulls" | ||
|
|
||
| link.xref_links.update({link_name: (link_text, link_url)}) |
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| from . import link | ||
|
|
||
| link_name = "GrapesJS issue queue" | ||
| link_text = "GrapesJS builder issues" | ||
| link_url = "https://github.com/mautic/mautic/issues?q=is%3Aopen+is%3Aissue+label%3Abuilder-grapesjs" | ||
|
|
||
| link.xref_links.update({link_name: (link_text, link_url)}) |
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| from . import link | ||
|
|
||
| link_name = "GrapesJS Preset" | ||
| link_text = "GrapesJS Preset" | ||
| link_url = "https://github.com/mautic/grapesjs-preset-mautic" | ||
|
|
||
| link.xref_links.update({link_name: (link_text, link_url)}) |
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| from . import link | ||
|
|
||
| link_name = "Symfony Cache" | ||
| link_text = "Symfony Cache" | ||
| link_url = "https://symfony.com/doc/5.4/cache.html#configuring-cache-with-frameworkbundle" | ||
|
|
||
| link.xref_links.update({link_name: (link_text, link_url)}) |
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
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.
I think we need to be a bit more verbose here. Where exactly do they run
npm install? Do they have to have Mautic installed first?We need to assume that people reading this are completely new to using the builder and may not know where to start.