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

feat: add Hosting.MailPit docs for the pr under CommunityToolkit #2633

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prom3theu5
Copy link

@prom3theu5 prom3theu5 commented Feb 17, 2025

This pull request adds supporting documentation for the MailPit hosting integration in the Community Toolkit tracked by CommunityToolkit/Aspire#476


Internal previews

📄 File 🔗 Preview link
docs/community-toolkit/hosting-mailpit.md .NET Aspire Community Toolkit MailPit integration
docs/community-toolkit/overview.md Overview

@prom3theu5
Copy link
Author

@dotnet-policy-service agree

Comment on lines +80 to +82
var mailpit = builder.AddMailPit("mailpit")
.WithDataBindMount(
source: @"C:\MailPit\Data");
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
var mailpit = builder.AddMailPit("mailpit")
.WithDataBindMount(
source: @"C:\MailPit\Data");
var mailpit = builder.AddMailPit("mailpit")
.WithDataBindMount(source: @"C:\MailPit\Data");

Data bind mounts rely on the host machine's filesystem to persist the MailPit data across container restarts. The data bind mount is mounted at the `C:\MailPit\Data` on Windows (or `/MailPit/Data` on Unix) path on the host machine in the MailPit container. For more information on data bind mounts, see [Docker docs: Bind mounts](https://docs.docker.com/engine/storage/bind-mounts).

## Client integration

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
There isn't a Community Toolkit client integration, however, if you're consuming the resource, it's good to know how to configure your clients.

Copy link
Member

Choose a reason for hiding this comment

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

This article needs to be added to the TOC, under here: https://github.com/dotnet/docs-aspire/blob/main/docs/toc.yml#L289

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants