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

docs: Add Email Notifications info #9930

Merged
merged 11 commits into from
Jun 9, 2024

Conversation

aviv926
Copy link
Contributor

@aviv926 aviv926 commented Jun 1, 2024

This PR adds information to the documentation about the email notification options in Immich.

Would we like to include this information in the Administration section or under Features?

In #9736, if I understood correctly then we include user preferences for email messages, would we like to add information about this?

@aviv926 aviv926 added the documentation Improvements or additions to documentation label Jun 1, 2024
@aviv926 aviv926 changed the title Docs: Add Email Notifications info docs: Add Email Notifications info Jun 1, 2024
- A user is added to a shared album (send email to the newly shared user).
- A shared album is added with new assets (send an email to all shared users beside the one that is adding assets).

The easiest way to set up a mail server for notifications is through Google, you may want to avoid using Gmail for privacy reasons or as part of your degoogle plan, you can use any SMTP server that can support login using name and password.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this will be better in the Guide section. In this section we just describe that is the Email notification feature, how can we set it up, what are the parameter...etc

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe remove this section?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we should remove this section completely, as this is a scenario many (if not most) users will run into. I agree with Alex in that we should move this section to a guide though

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So what sections would we like to leave on this page?


## Create an app password

First, it is recommended to create a dedicated Google account for your Immich instance, and not to mix it with your main Google account.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this your opinion? We should be subjective in writing documentation

Copy link
Member

Choose a reason for hiding this comment

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

We should not be subjective :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I put it in a :::tip:::, if you think it should be removed, tell me.

docs/docs/administration/email-notification.md Outdated Show resolved Hide resolved
docs/docs/administration/email-notification.md Outdated Show resolved Hide resolved
- A user is added to a shared album (send email to the newly shared user).
- A shared album is added with new assets (send an email to all shared users beside the one that is adding assets).

The easiest way to set up a mail server for notifications is through Google, you may want to avoid using Gmail for privacy reasons or as part of your degoogle plan, you can use any SMTP server that can support login using name and password.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we should remove this section completely, as this is a scenario many (if not most) users will run into. I agree with Alex in that we should move this section to a guide though

docs/docs/administration/email-notification.md Outdated Show resolved Hide resolved
docs/docs/administration/email-notification.md Outdated Show resolved Hide resolved
@alextran1502 alextran1502 enabled auto-merge (squash) June 9, 2024 20:01
@alextran1502 alextran1502 merged commit 84da9ab into immich-app:main Jun 9, 2024
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants