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 relay host config guide for Gmail #3958
Conversation
IMO the term "Gmail SMTP" is a bit confusing. Why not something like "(Configuring) Gmail as relay host"? PS: If you replace |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution!
Most of this feedback I've provided suggestions you can apply via Github directly, then you can apply any additional changes manually 👍
Guide for applying suggestions via Github web UI
If you're new to these reviews (I think you mentioned this is something you are getting experience at?), you can go into the "Files changed" tab here:
Then you will see each suggestion that has been provided by reviewers has a "Add suggestion to batch" button, click these if you agree and want to let Github apply the update:
Up top you'll get another button "Commit suggestions" that you can use once you've added all the suggestions you want to apply, it will let you enter a commit message and confirm to add all the suggestions you selected in a single commit:
!!! warning "Process of providing RELAY_PASSWORD" | ||
|
||
You should use your [2-step verification app password][gmail-smtp::2-step-password], **not** your gmail account password. | ||
`setup relay add-auth` is a better alternative, which manages the credentials via a config file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohhhh ok. So what is the value from the earlier Gmail Account ID link? (not accessible if you're not signed in)
You are definitely going for the personal Gmail here and this admonition is good to raise awareness that it should be an App Password, not the users personal credentials. I think that extra clarity should be added to the earlier example with link instead of "Gmail Account ID"?
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Casper <casperklein@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- apply two ways (First, setup through Google Workspace and trusts via IP address, Second, regular credentials and there's 2FA) to configure for relay with gmail. Previously i suggested only one method!
- change words 'Gmail SMTP' to 'Configure Gmail as a relay host'
- removed tips that may not be helpful.
Thanks for @polarathene help.
If you have any further requests please comment me.
Documentation preview for this PR is ready! 🎉 Built with commit: df82202 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the quick response to feedback! 😎
I've manually applied some additional changes and will merge this now. Great first contribution thanks! ❤️
Description
deployed docs example
I used Gmail as the relay host and succeeded after several attempts. Based on this experience, I would like to contribute to the docs on how to quickly connect to Gmail SMTP.
Currently, the part about integrating with the Gmail SMTP server cannot be found in the guide.
Therefore, I created guidelines such as how to use two-step authentication to use Gmail SMTP, what values should be entered in the host and port, and how to change the sender address.
Here is the link if this docs will be deployed. Gmail SMTP
Type of change
Checklist
docs/
)CHANGELOG.md