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

Add documentation for Emails and Messages app #821

Merged
merged 13 commits into from
Jul 12, 2023
Merged

Conversation

krzysztofwolski
Copy link
Member

  • Add Emails and Messages documentation
  • Sort app cards on the overview page

@krzysztofwolski krzysztofwolski requested a review from a team as a code owner July 6, 2023 10:50
@vercel
Copy link

vercel bot commented Jul 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saleor-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 12, 2023 9:56am

- use only the specific channels
- use all channels except the specific ones

## Development
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably worth linking https://docs.saleor.io/docs/3.x/developer/app-store/development

and leave here only app specific stuff

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Member

@peelar peelar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: blocking
polish: non-blocking
suggestion: should have blocking/non-blocking labels


## Supported events

The application is listening to the following events:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question:

What type of events are these? Because I don't see them on the webhook events list.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The list was copied from old plugin.

Reorganized this section to contain more info on where those events come from and added links for non-trivial topics like activating the account. WDYT?

docs/developer/app-store/apps/emails-and-messages/smtp.mdx Outdated Show resolved Hide resolved
docs/developer/app-store/apps/emails-and-messages/smtp.mdx Outdated Show resolved Hide resolved
@zaiste
Copy link
Contributor

zaiste commented Jul 10, 2023

@krzysztofwolski could we move this forward?

krzysztofwolski and others added 2 commits July 12, 2023 11:27
Co-authored-by: Adrian Pilarczyk <adrianpilarczyk314@gmail.com>
@krzysztofwolski
Copy link
Member Author

@zaiste code owner review required to merge. Could you take a look?


1. Create an account at [MailSlurp](https://www.mailslurp.com/)
2. Create a new inbox - [documentation](https://www.mailslurp.com/guides/creating-inboxes/)
3. Use the inbox address to create a new sender in Sendgrid - [documentation](https://docs.sendgrid.com/ui/sending-email/senders)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

polish: I think it looks nicer to link to the docs right from the corresponding fragment.

Suggested change
3. Use the inbox address to create a new sender in Sendgrid - [documentation](https://docs.sendgrid.com/ui/sending-email/senders)
3. Use the inbox address to [create a new sender in Sendgrid](https://docs.sendgrid.com/ui/sending-email/senders)

@lkostrowski lkostrowski merged commit 28d9562 into main Jul 12, 2023
2 checks passed
@lkostrowski lkostrowski deleted the eam-documentation branch July 12, 2023 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants