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

Use default instance names in operator documentation #186

Open
guenter opened this issue Jan 13, 2020 · 1 comment
Open

Use default instance names in operator documentation #186

guenter opened this issue Jan 13, 2020 · 1 comment

Comments

@guenter
Copy link
Member

guenter commented Jan 13, 2020

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.

@zmalik
Copy link
Member

zmalik commented Jan 16, 2020

yes, the documentation is outdated and was created at first place when we had random instance names. Now with the default name operatorName-instance we should make it simple. I will open a PR to fix it for Kafka

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants