Add migration guide for brevo module v2 to v3 #3256
Conversation
This file contains 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
juliawegmayr
force-pushed
the
migration-guide-for-brevo-module
branch
from
c456080 to
da30710
Compare
johnnyomair
reviewed
Jan 23, 2025
docs/docs/9-brevo-module/index.md
Outdated
There was a problem hiding this comment.
This should be in the Features/Modules section
Comment on lines
5
to
8
| Make sure, that your project is compatible with COMET v7: | ||
|
|
||
| - Now requires >= v7.10.0 for @comet packages | ||
| - Now requires >= 5.9.8 for @mikro-orm packages (except @mikro-orm/nestjs where >= 5.2.3 is required) |
There was a problem hiding this comment.
Suggested change
| Make sure, that your project is compatible with COMET v7: | |
| - Now requires >= v7.10.0 for @comet packages | |
| - Now requires >= 5.9.8 for @mikro-orm packages (except @mikro-orm/nestjs where >= 5.2.3 is required) | |
| Make sure, that your project uses COMET v7.10.0 or later. |
We could even use a warning admonition here.
| }); | ||
| ``` | ||
|
|
||
| ### Import `PublicUploadsModule` in the project's `AppModule` |
There was a problem hiding this comment.
The public uploads module has been rename to file uploads in Comet v7
There was a problem hiding this comment.
Thanks - I got it wrong from the changeset. It's correct in the code.
|
|
||
| Install `@comet/brevo-mail-rendering` in your project's site. This package offers reuseable frontend components for rendering emails. | ||
|
|
||
| Optional: You can use the `NewsLetterImageBlock` for rendering Images in your Newsletter campaigns. |
There was a problem hiding this comment.
General question: Is the casing really NewsLetter? Shouldn't it be Newsletter?
There was a problem hiding this comment.
No, that's a typo - thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Add migration guide for updating brevo from v2 to v3
Acceptance criteria
Open TODOs/questions
Further information