-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scholzj
requested changes
Apr 8, 2019
Looks good to me |
PaulRMellor
approved these changes
Apr 9, 2019
There was a problem hiding this 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
scholzj
approved these changes
Apr 9, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Select the type of your PR
Description
This pull request modifies three procedures to clarify which YAML file is applied.
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
./design