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

Documentation/Tutorials for setting up PubSub component are unclear #4322

Open
rakeshwalisheter opened this issue Aug 18, 2024 · 0 comments
Open
Assignees
Labels
content/incorrect-information Content in the docs is incorrect

Comments

@rakeshwalisheter
Copy link

rakeshwalisheter commented Aug 18, 2024

Describe the issue

  • Declarative subscription guide illustrates subscribing to a orders topic with route to the subscription as /checkout. This is already confusing since the example uses checkout entity as being the 'publisher'. Why is the publisher subscribing..?
  • Programmatic subscription guide with Python illustrates subscribing to a checkout topic with route to the subscription as /order. This is breaking consistency with the first example which the doc states is being replicated in the prog-subscription documentation. For folks like me, who don't know better, this will cause a lot of confusion.
  • In the declarative subscription, why does scopes include both checkout and orderprocessing ..? isn't it supposed to be just orderprocessing that is subscribing..?

URL of the docs
https://docs.dapr.io/developing-applications/building-blocks/pubsub/subscription-methods/#declarative-subscriptions
https://docs.dapr.io/developing-applications/building-blocks/pubsub/subscription-methods/#programmatic-subscriptions

Expected content

Screenshots

Additional context

@rakeshwalisheter rakeshwalisheter added the content/incorrect-information Content in the docs is incorrect label Aug 18, 2024
@rakeshwalisheter rakeshwalisheter changed the title Documentation is misleading for folk trying this out for the first time Documentation/Tutorials for setting up PubSub component are unclear Aug 19, 2024
@hhunter-ms hhunter-ms self-assigned this Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content/incorrect-information Content in the docs is incorrect
Projects
None yet
Development

No branches or pull requests

2 participants