Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Email theme generation documentation #269

Merged
merged 13 commits into from Jul 5, 2019

Conversation

@jolelievre
Copy link
Contributor

commented May 17, 2019

Introduce documentation about the "Email theme" component

  • general description of the feature
  • detailed workflow
  • available hooks
  • tutorials on how to use the feature in your modules
  • example module

Fixes #208

@jolelievre jolelievre changed the title Email theme generation documentation WIP: Email theme generation documentation May 17, 2019

@jolelievre jolelievre changed the title WIP: Email theme generation documentation Email theme generation documentation May 17, 2019

weight: 2
---

# The Email Theme component

This comment has been minimized.

Copy link
@sarjon

sarjon May 17, 2019

Member

Wouldn't it make more sense to call it Mail Template component to follow same naming that is in code?

This comment has been minimized.

Copy link
@jolelievre

jolelievre May 23, 2019

Author Contributor

This would we logical from a developper perspective, but the page in the back office is named "Email theme" so I thought matching with this would be more "user friendly"

This comment has been minimized.

Copy link
@jolelievre

jolelievre May 23, 2019

Author Contributor

Besides the word "template" is a bit confusing in this situation, I had to add a section Vocabulary in this doc to avoid confusion between layout and template.. not really easy to find correct and clear naming on this feature

This comment has been minimized.

Copy link
@sarjon

sarjon May 23, 2019

Member

Well, it's developer documentation, so calling same component in different names is weird imo. It's the same as calling Grid component in code, but List component in docs.

@eternoendless

This comment has been minimized.

Copy link
Member

commented May 29, 2019

Please consider moving the tutorials to the Modules section

@jolelievre

This comment has been minimized.

Copy link
Contributor Author

commented Jun 6, 2019

Please consider moving the tutorials to the Modules section

That's fine for me, but I don't know in which subpart I could put it. The architecture of the modules section isn't very clear. And although this doc contains some examples about extending the themes via a module there are also more generic info about the generator. Which will be probably extended when the feature is improved (configurable theme for example, along with how you set their configuration).

@jolelievre jolelievre force-pushed the jolelievre:email-theme branch from 422de62 to a540219 Jul 3, 2019

@jolelievre

This comment has been minimized.

Copy link
Contributor Author

commented Jul 4, 2019

@eternoendless Alright I moved the tutorials in the module section, the workflow and feature is still in the Components section, this seemed more logical to me.
And the example module has been merged as well https://github.com/PrestaShop/example_module_mailtheme
So if it's ok for you we can merge this doc as well!

@jolelievre jolelievre force-pushed the jolelievre:email-theme branch from d1be83f to 7479308 Jul 4, 2019

@jolelievre jolelievre merged commit 2d8dcbb into PrestaShop:master Jul 5, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.