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

Add Rust hosting docs #2041

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

Alirexaa
Copy link
Contributor

@Alirexaa Alirexaa commented Nov 12, 2024

Summary

This pull request adds documentation for the new Rust hosting integration in the .NET Aspire Community Toolkit. The most important changes include adding a new documentation file for Rust hosting, updating the integrations overview to include Rust hosting, and adding a link to the Rust hosting documentation in the table of contents.

Documentation updates:

  • Added docs/community-toolkit/hosting-rust.md to provide detailed instructions on how to use the .NET Aspire Rust hosting integration to host Rust applications.
  • Updated docs/fundamentals/integrations-overview.md to include a new entry for Rust hosting, linking to the new documentation and providing a brief description of the integration.
  • Modified docs/toc.yml to add a link to the Rust hosting documentation under the community toolkit section.

Fixes #2030


Internal previews

📄 File 🔗 Preview link
docs/community-toolkit/hosting-rust.md .NET Aspire Rust hosting
docs/fundamentals/integrations-overview.md .NET Aspire integrations overview
docs/toc.yml docs/toc

@Alirexaa Alirexaa marked this pull request as ready for review November 12, 2024 20:43

[!INCLUDE [banner](includes/banner.md)]

In this article, you learn how to use the .NET Aspire Rust hosting integration to host Rust applications.
Copy link
Member

Choose a reason for hiding this comment

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

The intro paragraph needs to be a bit more detailed. It should link to Rust docs, and describe exactly what the value-proposition is that the hosting integration is providing. For inspiration, see the intro paragraph here.


For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-package) or [Manage package dependencies in .NET applications](/dotnet/core/tools/dependencies).

## Example usage
Copy link
Member

Choose a reason for hiding this comment

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

This section should be expanded and the heading renamed to something more meaningful. Also, if there are more APIs or overloads they should be described here as well. For inspiration, see this example.

var rust = builder.AddRustApp("rust-app", "../rust-service");
```

The Rust application can be added as a reference to other resources in the AppHost project.
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
The Rust application can be added as a reference to other resources in the AppHost project.
The Rust application can be added as a reference to other resources in the app host project.

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.

[Community Toolkit New article]: Rust Hosting
2 participants