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

docs(overview): updates component descriptions #10595

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Sep 17, 2024

Documentation

Updates the overview content describing Kafka components to reduce the focus on ZooKeeper
Component diagram update to remove ZooKeeper is a placeholder.
A new diagram will replace it to organise the components better

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

@PaulRMellor PaulRMellor added this to the 0.44.0 milestone Sep 17, 2024
@PaulRMellor PaulRMellor requested a review from a team September 17, 2024 14:06
@PaulRMellor PaulRMellor self-assigned this Sep 17, 2024
Copy link
Member

@scholzj scholzj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks.

@ppatierno
Copy link
Member

I was wondering why we are anticipating these changes in the doc while ZooKeeper is still around. I mean, at some point, the doc would need additional changes because something like this "A KRaft-based Kafka cluster ....." will need to be fixed as just "A Kafka cluster ..." to make KRaft implicit because ZooKeeper was gone.

@scholzj
Copy link
Member

scholzj commented Sep 18, 2024

@ppatierno My take ... more and more people now use KRaft. So I think making it gradually more prominent in the docs corresponds to it.

@im-konge im-konge merged commit 926a850 into strimzi:main Sep 19, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants