Updates to "Get started with the RabbitMQ integrations" docs#1394
Updates to "Get started with the RabbitMQ integrations" docs#1394jasontaylordev wants to merge 2 commits into
Conversation
jasontaylordev
commented
Jul 23, 2026
- Clarified that RabbitMQ is easy to deploy "in cloud environments" instead of "on cloud environments" for more accurate language.
- Added a new section explaining how Aspire can be used with messaging frameworks
- Added links to messaging samples in See also section
There was a problem hiding this comment.
Pull request overview
Updates the RabbitMQ “Get started” integration page to refine introductory wording, add guidance for using RabbitMQ with higher-level messaging frameworks, and expand cross-references to relevant samples.
Changes:
- Adjusts the intro sentence to say RabbitMQ is easy to deploy “in cloud environments” (instead of “on cloud environments”).
- Adds a “Use with messaging frameworks” section describing how Aspire-managed RabbitMQ can be used with frameworks like MassTransit and NServiceBus.
- Adds “See also” links to a MassTransit + Aspire sample repo and a Particular sample.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JamesNK
left a comment
There was a problem hiding this comment.
Documentation accuracy review
Sources: microsoft/aspire main @ 327570c17f4e337ea5ae4574a5fe6abee4a6838b; MassTransit/Sample-Aspire default branch @ 70e3a2dce5b51bf4c0db84846cda24287d3249fd; authoritative MassTransit and Particular documentation linked by this change.
Claims: 7 total — 3 verified, 2 verified with nuance, 1 contradicted, 0 unverifiable, 1 narrative-only.
Rendered-page test: Intended route: /integrations/messaging/rabbitmq/rabbitmq-get-started/, focusing on Use with messaging frameworks and the two new See also links. The local site could not be served because dependencies were absent and npm registry requests failed at TLS negotiation; no page content was exercised. This is an environment limitation, not a documentation defect.
Phase A — Claim verification
The core description is supported by Aspire's implementation: RabbitMQServerResource is a ContainerResource implementing IResourceWithConnectionString and IResourceWithEnvironment (src/Aspire.Hosting.RabbitMQ/RabbitMQServerResource.cs:9-11), and exposes host, port, username, password, and URI connection properties (:104-111). The Particular integration and RabbitMQ sample also match their linked documentation.
One cross-reference is materially misleading in this RabbitMQ-specific context; see the inline comment.
Verified and nuanced claims
- Verified: Aspire manages the RabbitMQ resource and provides connection information. Evidence:
microsoft/aspire:src/Aspire.Hosting.RabbitMQ/RabbitMQServerResource.cs:9-11,104-111. - Verified: Aspire continues to handle resource lifecycle and connection wiring when an application layers a messaging framework over RabbitMQ. Evidence: the resource derives from
ContainerResourceand implements the connection/environment interfaces atRabbitMQServerResource.cs:9-11. - Verified with nuance: MassTransit and NServiceBus provide handlers, sagas, outbox behavior, and failure-handling features. “Recoverability” is NServiceBus terminology; MassTransit documents the equivalent behavior as retry, redelivery, and faults.
- Verified: Particular's Aspire integration orchestrates NServiceBus endpoints and Service Platform components alongside RabbitMQ. Evidence:
https://docs.particular.net/platform/aspire/andhttps://docs.particular.net/samples/aspire/platform-rabbitmq/. - Verified: The Particular sample link demonstrates an AppHost with multiple NServiceBus endpoints and a RabbitMQ broker.
- Narrative-only: Changing “on cloud environments” to “in cloud environments” does not alter a factual claim.
Phase B — Doc-tester results
Full content-testing report
Focus Area: RabbitMQ get-started guide — "Use with messaging frameworks" section + 2 new See also links
| Category | Passed | Failed | Warnings |
|---|---|---|---|
| Content Accuracy | 0 | 0 | 0 |
| Code Examples | 0 | 0 | 0 |
| CLI Commands | 0 | 0 | 0 |
| Links | 0 | 0 | 0 |
| Environment/Setup | 1 | 1 | 0 |
Critical issues
Local dev server could not be started — npm registry unreachable
The worktree had no installed frontend packages or usable local pnpm cache. Starting the dev server required registry access, but requests to https://registry.npmjs.org failed during TLS negotiation (ERR_SSL_SSLV3_ALERT_HANDSHAKE_FAILURE; independently reproduced with curl). Offline installation also failed because required packages were not cached. This blocked browser testing before navigation began and is not a documentation defect.
Warnings
None recorded; testing did not reach page content.
Passed checks
- PR ref
8b544167bd64c5a65a412e77eebef959d8dbb3c2was fetched and verified. - The review workspace was restored cleanly after the attempt.
Recommendations
- Replace the unrelated MassTransit sample with one that actually demonstrates RabbitMQ, or remove it from this RabbitMQ-specific page.
- Re-run rendered-page checks in an environment with preinstalled frontend dependencies or working npm registry access.
Knowledge gap
The rendered section, anchor behavior, and external-link navigation remain untested because no local server URL could be obtained.
Routes/sections exercised: None. Intended route: /integrations/messaging/rabbitmq/rabbitmq-get-started/.
Local server URL: Not obtained.
PR ref served: Checked out but not served.
Critical issues: 1 environment blocker; warnings: 0.
|
|
||
| - [RabbitMQ documentation](https://www.rabbitmq.com/docs/) | ||
| - [AMQP 0-9-1 protocol overview](https://www.rabbitmq.com/tutorials/amqp-concepts/) | ||
| - [Sample using MassTransit with Aspire](https://github.com/MassTransit/Sample-Aspire) |
There was a problem hiding this comment.
This sample does use MassTransit with Aspire, but it does not use RabbitMQ. At MassTransit/Sample-Aspire default-branch HEAD 70e3a2dce5b51bf4c0db84846cda24287d3249fd, the AppHost adds PostgreSQL only, and the API/backend configure MassTransit with UsingPostgres(...); the repository contains no AddRabbitMQ, UsingRabbitMq, or RabbitMQ package reference. In this RabbitMQ-specific section, the link therefore implies a combination the sample does not demonstrate. Please replace it with a MassTransit + RabbitMQ + Aspire sample, or remove the link from this page.
Head branch was pushed to by a user without write access