Skip to content

Use default instance names in operator documentation #186

Open
@guenter

Description

@guenter

The current documentation sometimes assumes default instance names, and sometimes overrides the default, so commands in the docs don't work when copied verbatim.

For example the installation docs for Kafka override the names with --instance, but Kafka tries to connect to a ZooKeeper named zookeeper-instance, so it never comes up.

In another example, the docs for scaling Kafka sometimes assume the default instance name, and sometimes it is overridden.

My recommendation is to use the default instance names in the docs to keep things simple, and assume default instance names in parameter such as the ZooKeeper host names. I'm happy to make a pass if people agree but wanted to post this first to see if work is already underway.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions