feat: add documentation about smtp server

[insider89]

Summary by CodeRabbit

• New Features
  • Added a section in the documentation detailing the requirements for configuring an SMTP server for email integration with the BTP platform.
  • Included clear descriptions of necessary parameters and an example YAML configuration to assist users in setup.

[coderabbitai]

Walkthrough

The recent documentation update introduces essential guidelines for configuring an SMTP server to facilitate email communication from the BTP platform. It details the required parameters, enhancing user understanding and providing a YAML example for clarity. This addition significantly enriches the documentation, addressing a previously missing aspect of email integration.

Changes

Files	Change Summary
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md	Added a new section detailing SMTP server requirements, including configuration parameters and a YAML example for clarity.

Poem

🐇 In the fields where emails fly,
A new guide to help us try,
With SMTP settings, clear and bright,
Sending messages, what a delight!
So hop along, don't delay,
Configure your server, start today! 🌟

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md (2)

287-287: Remove trailing punctuation in heading.

Trailing punctuation in the heading is unnecessary and does not adhere to Markdownlint rule MD026.

- ### A typical set of parameters you should collect:
+ ### A typical set of parameters you should collect

Tools

Markdownlint

287-287: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

---

289-289: Remove loose punctuation mark.

Avoid using loose punctuation marks in the list for better readability.

- - `host`: the hostname of the SMTP server
+ - `host` - the hostname of the SMTP server

Tools

LanguageTool

[uncategorized] ~289-~289: Loose punctuation mark.
Context: ...parameters you should collect: - host: the hostname of the SMTP server - `port...

(UNLIKELY_OPENING_PUNCTUATION)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f9b4047 and 50c5cc1.

Files selected for processing (1)

• docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md (1 hunks)

Additional context used

LanguageTool

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md

[uncategorized] ~289-~289: Loose punctuation mark.
Context: ...parameters you should collect: - host: the hostname of the SMTP server - `port...

(UNLIKELY_OPENING_PUNCTUATION)

Markdownlint

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md

287-287: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)