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

[DOC] User feedback: Clarify which file is applied in procedures, plus style edits. #1517

Merged
merged 6 commits into from
Apr 10, 2019
Merged

[DOC] User feedback: Clarify which file is applied in procedures, plus style edits. #1517

merged 6 commits into from
Apr 10, 2019

Conversation

d-laing
Copy link
Member

@d-laing d-laing commented Apr 8, 2019

Type of change

Select the type of your PR

  • Documentation

Description

This pull request modifies three procedures to clarify which YAML file is applied.

  • Kafka broker configuration
  • Configuring authentication in Kafka brokers
  • Changing the number of replicas
  • Configuring Zookeeper

For each procedure, I modified the code samples to refer to _kafka.yaml_ instead of _my-file_. This is based on feedback from users.

I also took the opportunity to make some style edits across the procedures involved, and to the Kafka broker configuration assembly.

I changed the :ApacheKafkaBrokerConfig: attribute to refer to the latest Kafka documentation. I think we should make the same change to the other Kafka documentation link attributes.

Checklist

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

  • Update/write design documentation in ./design
  • 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

documentation/book/proc-configuring-kafka-brokers.adoc Outdated Show resolved Hide resolved
documentation/book/proc-configuring-kafka-brokers.adoc Outdated Show resolved Hide resolved
documentation/book/proc-configuring-zookeeper-nodes.adoc Outdated Show resolved Hide resolved
documentation/book/proc-configuring-zookeeper-nodes.adoc Outdated Show resolved Hide resolved
documentation/book/proc-kafka-authentication.adoc Outdated Show resolved Hide resolved
documentation/book/proc-kafka-authentication.adoc Outdated Show resolved Hide resolved
@PaulRMellor
Copy link
Contributor

Looks good to me

@PaulRMellor PaulRMellor closed this Apr 9, 2019
@PaulRMellor PaulRMellor reopened this Apr 9, 2019
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Looks good to me

@d-laing d-laing removed the request for review from tombentley April 10, 2019 09:22
@d-laing d-laing merged commit bed427b into strimzi:master Apr 10, 2019
@d-laing d-laing deleted the specify-files-in-procedures branch April 10, 2019 15:36
@scholzj scholzj added this to the 0.12.0 milestone Apr 10, 2019
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.

None yet

3 participants