Skip to content

How should component aliases be denoted in docs? #4801

@sicoyle

Description

@sicoyle

There are many aliases in our components. For example:

  • postgres = postgresql
  • mqtt = mqtt3
  • azure.servicebus.queues = azure.servicebusqueues

These are just a few 😅

If for example then I go to the docs, I only see a component for mqtt3, but not mqtt: https://docs.dapr.io/reference/components-reference/supported-bindings/mqtt3/
One could ask then "are docs for mqtt binding missing then"? This specific mqtt vs mqtt3 ex applies to both bindings and pubsub components.

This is confusing as both are technically registered in runtime (same for all of these aliases, and others that I don't have listed here). However, it is confusing for our end users when the metadata on the page uses the other alias, or maybe the quickstarts examples use the other alias. I think this case is more common on postgres tbh, but the concept holds. We should make aliases clear in the docs somehow, and then try our best to align quickstart/docs examples to use one as the source of truth.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions