-
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
docs(api): cleans up property descriptions #10318
Merged
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
Signed-off-by: prmellor <[email protected]>
scholzj
reviewed
Jul 9, 2024
...c/main/java/io/strimzi/api/kafka/model/kafka/listener/GenericKafkaListenerConfiguration.java
Outdated
Show resolved
Hide resolved
...c/main/java/io/strimzi/api/kafka/model/kafka/listener/GenericKafkaListenerConfiguration.java
Outdated
Show resolved
Hide resolved
...va/io/strimzi/api/kafka/model/kafka/listener/GenericKafkaListenerConfigurationBootstrap.java
Outdated
Show resolved
Hide resolved
...i/io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthenticationScramSha256.adoc
Outdated
Show resolved
Hide resolved
documentation/api/io.strimzi.api.kafka.model.kafka.KafkaAuthorizationOpa.adoc
Outdated
Show resolved
Hide resolved
documentation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListener.adoc
Show resolved
Hide resolved
...ntation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc
Show resolved
Hide resolved
...pi/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfigurationBootstrap.adoc
Outdated
Show resolved
Hide resolved
documentation/api/io.strimzi.api.kafka.model.mirrormaker.KafkaMirrorMakerConsumerSpec.adoc
Outdated
Show resolved
Hide resolved
documentation/api/io.strimzi.api.kafka.model.user.KafkaUserQuotas.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
scholzj
reviewed
Jul 15, 2024
...ntation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc
Outdated
Show resolved
Hide resolved
...ntation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc
Outdated
Show resolved
Hide resolved
...ntation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc
Outdated
Show resolved
Hide resolved
...pi/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfigurationBootstrap.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: prmellor <[email protected]>
scholzj
approved these changes
Jul 16, 2024
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.
One more it. But LGTM otherwise. I think you might also need to update the generated files to make the build pass.
...ntation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: prmellor <[email protected]>
Thanks for the additional comments @scholzj |
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.
Documentation
API reference cleanup
Note that ACL descriptions were re-added for the AclRule schema (removed in #9207)
There are still some lengthy descriptions for one or two tables, such as for the
CruiseControlSpec
schema.Out of scope for this PR, but as a phase 2 we could look to move such additional content and for each schema have the following only:
schema_name
Checklist
Please go through this checklist and make sure all applicable tasks have been done