Skip to content

Commit

Permalink
Fix links, add custom SMTP provider
Browse files Browse the repository at this point in the history
  • Loading branch information
Vincent (Wen Yu) Ge committed Feb 17, 2024
1 parent f141cc9 commit 5a6af3c
Show file tree
Hide file tree
Showing 22 changed files with 1,067 additions and 204 deletions.
49 changes: 45 additions & 4 deletions src/routes/docs/products/messaging/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@
{
label: 'Concepts',
items: [
{
label: 'Providers',
href: '/docs/products/messaging/providers'
},
{
label: 'Topics',
href: '/docs/products/messaging/topics'
Expand All @@ -39,6 +35,51 @@
]
},
{
label: 'Providers',
items: [
{
label: 'Push with APNs',
href: '/docs/products/messaging/apns'
},
{
label: 'Push with FCM',
href: '/docs/products/messaging/fcm'
},
{
label: 'Email with Mailgun',
href: '/docs/products/messaging/mailgun'
},
{
label: 'Email with Sendgrid',
href: '/docs/products/messaging/sendgrid'
},
{
label: 'Email with SMTP',
href: '/docs/products/messaging/smtp'
},
{
label: 'SMS with Twilio',
href: '/docs/products/messaging/twilio'
},
{
label: 'SMS with MSG91',
href: '/docs/products/messaging/msg91'
},
{
label: 'SMS with Telesign',
href: '/docs/products/messaging/telesign'
},
{
label: 'SMS with TextMagic',
href: '/docs/products/messaging/textmagic'
},
{
label: 'SMS with Vonage',
href: '/docs/products/messaging/vonage'
},
]
},
{
label: 'Journeys',
items: [
Expand Down
3 changes: 0 additions & 3 deletions src/routes/docs/products/messaging/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,4 @@ Send SMS messages straight to your user's phone.
{% cards_item href="/docs/products/messaging/send-push-notifications" title="Push notifications" %}
Send push notifications to your user's devices.
{% /cards_item %}
{% cards_item href="/docs/products/messaging/providers" title="Providers" %}
Integrate with 9 of the top messaging services.
{% /cards_item %}
{% /cards %}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: article
title: Apple Push Notification service
description: Send push notifications to apps on Apple devices through Apple Push Notification service (APNs) using Appwrite Messaging.
back: /docs/products/messaging/providers
back: /docs/
---

Apple Push Notification service (APNs) lets you send push notifications to Apple devices like macOS, iOS, tvOS, iPadOS, and watchOS devices.
Expand Down Expand Up @@ -34,20 +34,24 @@ You will need to provide the following information from the **Apple Developer Me
*
---
* Team ID
* Head to **Apple Developer Member Center** > **Membership details** > **Team ID**
{% only_dark %} ![Team ID](/images/docs/messaging/providers/apns/dark/team-id.png) {% /only_dark %} {% only_light %} ![Team ID](/images/docs/messaging/providers/apns/team-id.png) {% /only_light %}
*
Head to **Apple Developer Member Center** > **Membership details** > **Team ID**
{% only_dark %} ![Team ID](/images/docs/messaging/providers/apns/dark/team-id.png) {% /only_dark %} {% only_light %} ![Team ID](/images/docs/messaging/apns/team-id.png) {% /only_light %}
---
* Bundle ID
* Head to **Apple Developer Member Center** > **Program resources** > **Certificates, Identifiers & Profiles** > **Identifiers**
{% only_dark %} ![Bundle ID](/images/docs/messaging/providers/apns/dark/bundle-id.png) {% /only_dark %} {% only_light %} ![Bundle ID](/images/docs/messaging/providers/apns/bundle-id.png) {% /only_light %}
*
Head to **Apple Developer Member Center** > **Program resources** > **Certificates, Identifiers & Profiles** > **Identifiers**
{% only_dark %} ![Bundle ID](/images/docs/messaging/providers/apns/dark/bundle-id.png) {% /only_dark %} {% only_light %} ![Bundle ID](/images/docs/messaging/apns/bundle-id.png) {% /only_light %}
---
* Authentication key ID
* Head to **Apple Developer Member Center** > **Program resources** > **Certificates, Identifiers & Profiles** > **Keys**. Click on your key to view details. The key needs **Apple Push Notification Service** enabled.
{% only_dark %} ![Authentication Key ID](/images/docs/messaging/providers/apns/dark/key-id.png) {% /only_dark %} {% only_light %} ![Authentication Key ID](/images/docs/messaging/providers/apns/key-id.png) {% /only_light %}
*
Head to **Apple Developer Member Center** > **Program resources** > **Certificates, Identifiers & Profiles** > **Keys**. Click on your key to view details. The key needs **Apple Push Notification Service** enabled.
{% only_dark %} ![Authentication Key ID](/images/docs/messaging/providers/apns/dark/key-id.png) {% /only_dark %} {% only_light %} ![Authentication Key ID](/images/docs/messaging/apns/key-id.png) {% /only_light %}
---
* Authentication key (.p8 file)
* Head to **Apple Developer Member Center** > **Program resources** > **Certificates, Identifiers & Profiles** > **Keys**. Create a key and give it a name. Enable the Apple Push Notifications service (APNS), and register your key. The key needs **Apple Push Notification Service** enabled.
{% only_dark %} ![Authentication Key](/images/docs/messaging/providers/apns/dark/authentication-key.png) {% /only_dark %} {% only_light %} ![Authentication Key](/images/docs/messaging/providers/apns/authentication-key.png) {% /only_light %}
*
Head to **Apple Developer Member Center** > **Program resources** > **Certificates, Identifiers & Profiles** > **Keys**. Create a key and give it a name. Enable the Apple Push Notifications service (APNS), and register your key. The key needs **Apple Push Notification Service** enabled.
{% only_dark %} ![Authentication Key](/images/docs/messaging/providers/apns/dark/authentication-key.png) {% /only_dark %} {% only_light %} ![Authentication Key](/images/docs/messaging/apns/authentication-key.png) {% /only_light %}
{% /table %}

After adding the following details, click **Save and continue** to enable the provider.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: article
title: Firebase Cloud Messaging
description: Send push notifications to Android, Apple, or Web app with Firebase Cloud Messaging (FCM).
back: /docs/products/messaging/providers
back: /docs/
---

Firebase Cloud Messaging (FCM) lets you send push notifications to your iOS, Android, and web apps through Appwrite Messaging.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: article
title: Mailgun
description: Send emails to your Appwrite users using Mailgun and Appwrite Messaging.
back: /docs/products/messaging/providers
back: /docs/
---

Mailgun lets you send customized email messages to your users.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: article
title: MSG91
description: Send SMS messages to your Appwrite users using MSG91 and Appwrite Messaging.
back: /docs/products/messaging/providers
back: /docs/
---

MSG91 lets you send customized SMS messages to your users.
Expand All @@ -13,10 +13,10 @@ You can send SMS messages for purposes like reminders, promotions, announcements

To add MSG91 as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**.
{% only_dark %}
![Add a MSG91 provider](/images/docs/messaging/providers/msg91/dark/provider.png)
![Add a MSG91 provider](/images/docs/providers/messaging/msg91/dark/provider.png)
{% /only_dark %}
{% only_light %}
![Add a MSG91 provider](/images/docs/messaging/providers/msg91/provider.png)
![Add a MSG91 provider](/images/docs/providers/messaging/msg91/provider.png)
{% /only_light %}

Give your provider a name > choose **MSG91** > click **Save and continue**.
Expand Down Expand Up @@ -52,10 +52,10 @@ make sure you've configured [a topic](/docs/products/messaging/topics) and [a ta
{% tabsitem #console title="Console" %}
To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**.
{% only_dark %}
![Create email message](/images/docs/messaging/messages/dark/create-email-message.png)
![Create email message](/images/docs/providers/messaging/messages/dark/create-email-message.png)
{% /only_dark %}
{% only_light %}
![Create email message](/images/docs/messaging/messages/create-email-message.png)
![Create email message](/images/docs/providers/messaging/messages/create-email-message.png)
{% /only_light %}

Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**.
Expand Down
78 changes: 0 additions & 78 deletions src/routes/docs/products/messaging/providers/[email protected]

This file was deleted.

55 changes: 0 additions & 55 deletions src/routes/docs/products/messaging/providers/+page.markdoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can send custom email messages to your app's users using Appwrite Messaging
This guide takes you through the implementation path of adding email messaging to your app.

# Add a provider {% #add-a-provider %}
Appwrite supports [Mailgun](/docs/products/messaging/providers/mailgun/) and [Sendgird](/docs/products/messaging/providers/sendgrid/) as
Appwrite supports [Mailgun](/docs/products/messaging/mailgun/) and [Sendgird](/docs/products/messaging/sendgrid/) as
SMTP providers. You must configure one of them as a provider.
{% only_dark %}
![Add a SMTP provider](/images/docs/messaging/providers/mailgun/dark/add-mailgun.png)
Expand All @@ -18,7 +18,7 @@ SMTP providers. You must configure one of them as a provider.
{% /only_light %}
To add a new provider navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **Email**
and follow the wizard. You can find more details about configuring in the provider guides for
[Mailgun](/docs/products/messaging/providers/mailgun#configure-provider) and [Sendgird](/docs/products/messaging/providers/sendgrid#configure-provider).
[Mailgun](/docs/products/messaging/mailgun#configure-provider) and [Sendgird](/docs/products/messaging/sendgrid#configure-provider).

# Add targets {% #add-targets %}
In Appwrite Messaging, each user has **targets** like their email, phone number, and devices with your app installed.
Expand Down
20 changes: 10 additions & 10 deletions src/routes/docs/products/messaging/send-sms-messages/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ You can send custom sms messages to your app's users using Appwrite Messaging an
This guide takes you through the implementation path of adding sms messaging to your app.

# Add a provider {% #add-a-provider %}
Appwrite supports [Twilio](/docs/products/messaging/providers/twilio/),
[MSG91](/docs/products/messaging/providers/msg91/),
[Telesign](/docs/products/messaging/providers/telesign/),
[TextMagic](/docs/products/messaging/providers/textmagic/),
and [Vonage](/docs/products/messaging/providers/vonage/)
Appwrite supports [Twilio](/docs/products/messaging/twilio/),
[MSG91](/docs/products/messaging/msg91/),
[Telesign](/docs/products/messaging/telesign/),
[TextMagic](/docs/products/messaging/textmagic/),
and [Vonage](/docs/products/messaging/vonage/)
as SMS providers. You must configure one of them as a provider.
{% only_dark %}
![Add a SMTP provider](/images/docs/messaging/providers/twilio/dark/provider.png)
Expand All @@ -22,11 +22,11 @@ as SMS providers. You must configure one of them as a provider.
{% /only_light %}
To add a new provider navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**
and follow the wizard. You can find more details about configuring in the provider guides for
[Twilio](/docs/products/messaging/providers/twilio/),
[MSG91](/docs/products/messaging/providers/msg91/),
[Telesign](/docs/products/messaging/providers/telesign/),
[TextMagic](/docs/products/messaging/providers/textmagic/),
and [Vonage](/docs/products/messaging/providers/vonage/).
[Twilio](/docs/products/messaging/twilio/),
[MSG91](/docs/products/messaging/msg91/),
[Telesign](/docs/products/messaging/telesign/),
[TextMagic](/docs/products/messaging/textmagic/),
and [Vonage](/docs/products/messaging/vonage/).

# Add targets {% #add-targets %}
In Appwrite Messaging, each user has **targets** like their email, phone number, and devices with your app installed.
Expand Down
Loading

0 comments on commit 5a6af3c

Please sign in to comment.