Skip to content

[Docs]: Should we use the term Kafka Bridge as a name of the components? #11743

@scholzj

Description

@scholzj

Suggestion / Problem

Strimzi has a custom resource named KafkaBridge which is used to deploy the Strimzi HTTP Bridge for Apache Kafka. We obviously cannot change the name of the custom resource used at the technical level. But in most of the documentation, we refer to the whole tool as to Kafka Bridge even when not talking about the custom resource kind.

That seems wrong as it might give people the idea that the Kafka Bridge is a component of Apache Kafka, similarly to when we talk about Kafka Connect or Kafka MIrrorMaker2. I think we should refer to it as Strimzi Bridge, Strimzi HTTP Bridge, or HTTP Bridge and leave the Kafka part out. And the term KafkaBridge should be used only when specifically refering to the resource kind.

Documentation Link

See this chapter as an example of where we use the ?wrong? name: https://strimzi.io/docs/operators/latest/full/deploying.html#kafka-bridge-str

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions