[docs] SMTP config #5124
[docs] SMTP config #5124
Conversation
WalkthroughThe documentation for Pluggable Authentication in FiftyOne Teams has been updated to include a new section on "New User Invitations," detailing the onboarding process via invitation links. This feature allows Super Admins to create invitation links for internal mode, which can now be sent automatically via email through a configured SMTP server. The documentation clarifies the differences between legacy and internal authentication modes and notes that user invitations are not supported in internal mode. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
docs/source/teams/pluggable_auth.md (5)
73-84: Consider adding migration and compatibility details.The documentation would benefit from additional context about:
- Whether this is a breaking change for existing installations
- What happens to existing invitation methods after upgrading
- Whether organizations need to take any action during upgrade
85-94: Add security recommendations for SMTP configuration.Consider adding a security section that covers:
- Best practices for securing SMTP connections (e.g., TLS requirements)
- Recommendations for handling credentials
- Network security considerations
109-113: Enhance error handling and troubleshooting documentation.The preliminary check for SMTP server reachability should include:
- Common error scenarios and their solutions
- Specific error messages users might encounter
- Steps to diagnose connection issues
114-117: Document email customization capabilities.Consider adding information about:
- Email template customization options
- Available variables/placeholders in templates
- Language/localization support for emails
73-122: Maintain consistent markdown formatting.Ensure consistent formatting throughout the documentation:
- Use consistent quote styles (backticks vs. single/double quotes)
- Maintain consistent spacing around headers
- Align indentation in lists
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (4)
docs/source/images/teams/cas/SMTP_config.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/teams/cas/SMTP_config_test_email.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/teams/cas/org_enable_invitations.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/teams/cas/org_send_email_invitations.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
docs/source/teams/pluggable_auth.md(1 hunks)
| can be manually sent to users. When those users click the links, they will be | ||
| added to the Organization and prompted to log in. | ||
|
|
||
| As of FiftyOne Teams 2.2.0, these invitation links can be automatically sent |
| > **NOTE:** Unless the deployment is a Managed Deployment, users must provide | ||
| > their own SMTP server to use in [internal mode](#internal-mode). This new | ||
| > functionality provides a way to authenticate and communicate with your | ||
| > existing mail server. |
There was a problem hiding this comment.
Are we providing SMTP server to managed customers in 2.2 release?
What changes are proposed in this pull request?
Added docs and associated images for configuring SMTP connections
Summary by CodeRabbit
New Features
Documentation