Update SMTP template docs #368

gewenyu99 · 2023-05-05T22:34:57Z

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

gewenyu99 · 2023-05-08T22:01:44Z

app/views/docs/email-and-sms-templates.phtml

+    <tbody>
+    <tr>
+        <td>Sender name</td>
+        <td>[TODO: @damodar where is this used?].</td>


@lohanidamodar

used as From name while sending the email
https://github.com/appwrite/appwrite/blob/6700f90ba150a5065088cbd15d1164a1cd3e15a2/app/workers/mails.php#L59

gewenyu99 · 2023-05-08T22:01:54Z

app/views/docs/email-and-sms-templates.phtml

+    </tr>
+    <tr>
+        <td>Sender email</td>
+        <td>[TODO: @damodar which part of this can be configured? Does it have to do with the SMTP configuration?].</td>


@lohanidamodar

Whole email is configurable, but they should be careful, as the SMTP config should allow this email as the sender email. And whole custom email templates can only be changed when custom SMTP configuration is setup

gewenyu99 · 2023-05-08T22:02:01Z

app/views/docs/email-and-sms-templates.phtml

+    </tr>
+    <tr>
+        <td>Reply to</td>
+        <td>[TODO: @damodar Where is this displayed, if empty is no reply?].</td>


@lohanidamodar

Used as email's reply to address. If empty it's not used.

gewenyu99 · 2023-05-08T22:02:07Z

app/views/docs/email-and-sms-templates.phtml

+    </tbody>
+</table>
+<h3><a href="#email-template-syntax" id="email-template-syntax">Email Template Syntax</a></h3>
+<p>[TODO: @damodar are these variables accessible only in the Message tempalte or also the other components?]</p>


@lohanidamodar

Not decided yet, for now let's say only Message

gewenyu99 · 2023-05-08T22:02:19Z

app/views/docs/email-and-sms-templates.phtml

+    <li>In your project, navigate to the <b>Auth</b> service.</li>
+    <li>Under the <b>Auth</b> service, navigate to the <b>Templates</b> tab.</li>
+    <li>Expand the email template you want to edit.</li>
+    <li>Select the <b>Template language</b> [TODO: @damodar is this used for localization? Can you configure a different template for each language?].</li>


@lohanidamodar

Yes, that's the idea, each language will have different SMSs and Emails templates

lohanidamodar

Replied to all the comments.

gewenyu99 · 2023-05-18T22:23:40Z

@lohanidamodar Please review again, anything missing from this?

lohanidamodar

Looks good, but I think the SMS template section is missing ?

gewenyu99 · 2023-05-24T20:51:42Z

Looks good, but I think the SMS template section is missing ?

Ooooo We're also doing SMS this release?

gewenyu99 · 2023-05-25T18:07:23Z

OBSOLETE COMMENT

eldadfux · 2023-06-04T04:33:22Z

Leftover:

eldadfux · 2023-06-04T04:35:12Z

I think we should also change the title to match the navigation link. This page will also create confusion with the existing SMS delivery page. I suggest we add a comment on both pages, warning readers in case they're looking for the other page.

eldadfux · 2023-06-04T04:36:39Z

app/views/docs/email-and-sms-templates.phtml

+<p>Appwrite uses emails messages to perform user invite, user verification, login, and reset password. Emails messages can be customized to fit your app's design and voice.</p>
+
+<h2><a href="#customize" id="customize">Customize Templates</a></h2>
+<p>You can customize email templates in the Appwrite console.</p>


Suggested change

<p>You can customize email templates in the Appwrite console.</p>

<p>You can customize email templates for each of your projects in the Appwrite console. </p>

eldadfux · 2023-06-04T04:37:56Z

app/views/docs/email-and-sms-templates.phtml

@@ -0,0 +1,128 @@
+<p>Appwrite uses emails messages to perform user invite, user verification, login, and reset password. Emails messages can be customized to fit your app's design and voice.</p>


The page is mostly focused on emails, while we also support SMS templates and maybe other in the future, we need to make the docs more balanced. I would also mention you can customize them per project and for multiple languages at the top of the page linking to more information on how to manage localization in Appwrite.

I might even add a table of content for quick links to emails vs sms.

Localization might be worth its own section with a code example.

😆 Some of these sections are new, for a while I thought SMS delivery wasn't going to be added yet.

eldadfux · 2023-06-04T05:03:13Z

I think we could also benefit from a console screenshot here.

lohanidamodar

left comments

lohanidamodar · 2023-06-06T00:14:55Z

app/views/docs/email-and-sms-templates.phtml

@@ -0,0 +1,145 @@
+<p>Appwrite uses email and SMS messages to communicate with users to perform authentication actions. Emails and SMS messages can be customized to fit your app's design and voice.</p>
+
+<p>Each Appwrite project can have its own set of unique templates. Templates also support localization, every template can be written in multiple languages and served depending on the [TODO: @dlohani]</p>


not sure how this should go yet, for now we could just keep up to. We don't yet have method to set locale in projects?

I am not aware of it...

There is client.setLocale method that set's the locale header X-Appwrite-Locale, which then determines which local to use.

lohanidamodar · 2023-06-06T00:15:59Z

app/views/docs/email-and-sms-templates.phtml

+</table>
+
+<h3><a href="#email-template-examples" id="email-template-components">Email Template Components</a></h3>
+[TODO: @dlohani once we're ready, let's do examples for each type of template (maybe also what it would look like rendered)]


What do you mean by Email Template components?

If its' console UI, then Arman already has it.

What do you mean by Email Template components?

Sorry, I mean email template Examples

it should be ready, you can check with @ArmanNik

lohanidamodar · 2023-06-06T00:17:34Z

app/views/docs/email-and-sms-templates.phtml

+
+<h2>Localization</h2>
+[TODO: @dlohani short description of how it's decided which language's template is sent]
+[TODO: @dlohani Maybe example of a template in two languages? (maybe also what it would look like rendered)]


what do you mean by this?

So we would just describe how users would set their templates, then show the same message for an email template in two languages + screenshots.

This just fully demonstrates how localization works.

by using client.setLocale to set the locale header.

app/views/docs/email-and-sms-templates.phtml

Meldiron · 2023-08-25T06:29:44Z

app/views/docs/email-and-sms-templates.phtml

+&lt/html&gt</code></pre>
+</div>
+
+<h2><a href="#sms-templates" id="sms-templates">SMS Templates</a></h2>


We should not mention SMS templates. This section should be gone, and in introduction we shouldn't talk about it.

We disabled this feature for now. We will add it back when we add support for custom SMS provider.

app/views/docs/email-and-sms-templates.phtml

Meldiron

Other than the suggestions I provided, this LGTM. Only accept those that make sense to you as well.

Co-authored-by: Matej Bačo <matejbaco2000@gmail.com>

…o smtp-templates

gewenyu99 · 2023-08-29T13:57:52Z

gewenyu99 and others added 3 commits March 28, 2023 22:11

Init SMTP template docs

01585c2

Use relative links

d61ac64

Add placeholders for docs

0c444f7

gewenyu99 requested a review from lohanidamodar May 8, 2023 22:01

gewenyu99 commented May 8, 2023

View reviewed changes

lohanidamodar reviewed May 10, 2023

View reviewed changes

Update email template docs with Damodar's comments

703d2c3

gewenyu99 requested a review from lohanidamodar May 18, 2023 22:23

gewenyu99 marked this pull request as ready for review May 18, 2023 22:23

lohanidamodar suggested changes May 22, 2023

View reviewed changes

Add SMS into the templates page

5b880ec

gewenyu99 requested a review from lohanidamodar May 25, 2023 17:26

Fix table heading for variables

455b4bf

lohanidamodar approved these changes Jun 4, 2023

View reviewed changes

eldadfux suggested changes Jun 4, 2023

View reviewed changes

Added more to template docs

2319af0

lohanidamodar reviewed Jun 6, 2023

View reviewed changes

gewenyu99 commented Jun 6, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

gewenyu99 requested review from lohanidamodar and eldadfux June 6, 2023 15:18

Vincent (Wen Yu) Ge added 3 commits June 6, 2023 11:19

Update app/views/docs/email-and-sms-templates.phtml

4a01a38

Update app/views/docs/email-and-sms-templates.phtml

601dd29

Update event object's attribute key names

6158cf8

gewenyu99 changed the base branch from main to 1.4.x August 23, 2023 20:43

PineappleIOnic approved these changes Aug 24, 2023

View reviewed changes

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron reviewed Aug 25, 2023

View reviewed changes

app/views/docs/email-and-sms-templates.phtml Outdated Show resolved Hide resolved

Meldiron approved these changes Aug 25, 2023

View reviewed changes

Vincent (Wen Yu) Ge and others added 6 commits August 25, 2023 14:08

Update app/views/docs/email-and-sms-templates.phtml

b5dd068

Co-authored-by: Matej Bačo <matejbaco2000@gmail.com>

Update app/views/docs/email-and-sms-templates.phtml

e6b6fee

Co-authored-by: Matej Bačo <matejbaco2000@gmail.com>

Apply suggestions from code review

9249017

Co-authored-by: Matej Bačo <matejbaco2000@gmail.com>

Console capitalized

5353edf

remove reference of phone/sms template

7844c58

Fix index

24ebe2f

gewenyu99 requested a review from Meldiron August 25, 2023 19:03

Meldiron approved these changes Aug 27, 2023

View reviewed changes

Meldiron and others added 3 commits August 28, 2023 09:46

Merge branch '1.4.x' into smtp-templates

4dd15d6

Add SMTP steps

034de4a

Merge branch 'smtp-templates' of https://github.com/appwrite/docs int…

bc3f286

…o smtp-templates

gewenyu99 merged commit c292ef6 into 1.4.x Aug 29, 2023

github-actions bot mentioned this pull request Sep 1, 2023

PRs Closed in August 2023 appwrite/.github#70

Closed

gewenyu99 deleted the smtp-templates branch September 3, 2023 15:09

	<p>You can customize email templates in the Appwrite console.</p>
	<p>You can customize email templates for each of your projects in the Appwrite console. </p>

		@@ -0,0 +1,128 @@
		<p>Appwrite uses emails messages to perform user invite, user verification, login, and reset password. Emails messages can be customized to fit your app's design and voice.</p>

		@@ -0,0 +1,145 @@
		<p>Appwrite uses email and SMS messages to communicate with users to perform authentication actions. Emails and SMS messages can be customized to fit your app's design and voice.</p>

		<p>Each Appwrite project can have its own set of unique templates. Templates also support localization, every template can be written in multiple languages and served depending on the [TODO: @dlohani]</p>

Update SMTP template docs #368

Update SMTP template docs #368

Uh oh!

Conversation

gewenyu99 commented May 5, 2023

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lohanidamodar left a comment

Choose a reason for hiding this comment

Uh oh!

gewenyu99 commented May 18, 2023

Uh oh!

lohanidamodar left a comment

Choose a reason for hiding this comment

Uh oh!

gewenyu99 commented May 24, 2023

Uh oh!

gewenyu99 commented May 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eldadfux commented Jun 4, 2023

Uh oh!

eldadfux commented Jun 4, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eldadfux commented Jun 4, 2023

Uh oh!

lohanidamodar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gewenyu99 commented May 25, 2023 •

edited

Loading