本文以kafka 2.3.0版本的发布说明为例，学习下发布说明如何编写。
首先整体概括下发布说明内容
声明在某个产品的什么版本下解决什么类型的问题。完整发布说明文档(含指导书和项目信息)在什么地方(某个链接)。举例如下
Below is a summary of the JIRA issues addressed in the 2.3.0 release of Kafka. For full documentation of the release, a guide to get started, and information about the project, see theKafka project site.
升级注意事项：升级前认真阅读升级指导手册。升级说明讨论了有关不兼容性、重大变更、性能变更以及其他可能影响Kafka生产部署变更的所有重要信息。
Note about upgrades:Please carefully review the upgrade documentation for this release thoroughly before upgrading your cluster. The upgrade notes discuss any critical information about incompatibilities and breaking changes, performance changes, and any other changes that might impact your production deployment of Kafka.
The documentation for the most recent release can be found athttps://kafka.apache.org/documentation.html.
New Feature新特性清单
[KAFKA-4730] - Streams does not have an in-memory windowed store
Improvement改进点清单
[KAFKA-3816] - Provide more context in Kafka Connect log messages using MDC
Bug故障清单
[KAFKA-3143] - inconsistent state in ZK when all replicas are dead.
Task需求清单
[KAFKA-7766] - Improve fail-fast behavior of Jenkins buil
Wish愿景？
[KAFKA-7950] - Kafka tools GetOffsetShell -time description
Test测试内容
[KAFKA-8118] - Ensure that tests close ZooKeeper clients since they can impact subsequent tests
Sub-task子需求清单
[KAFKA-7832] - Use automatic RPC generation in CreateTopics
网友评论