pulsar
pulsar copied to clipboard
[refactor][doc] Refactor the information architecture of Schema topics
Motivation
Improve the doc set of the Schema chapter to provide Pulsar users with a more accurate, easy-to-read, and comprehensive information experience.
Fixes #18151
Modifications
- Curate a new
Overview
topic to introduce WHAT/WHY/HOW about Schema. - Curate a new
Get Started
topic to introduce how to construct a schema. - Improve the IA inside the
Understand Schema
andSchema evolution and compatibility
topics. -- Will evaluate whether it makes more sense to mergeSchema evolution and compatibility
intoUnderstand Schema
with more reviews. - Relocate content in
Manage Schema
intoAdmin Interfaces - Schemas
(new) andUnderstand Schema"
topics. - Move examples and references from
Client Libraries - Java/C++
to a single source insideGet started
. - Remove duplicate or redundant information.
Note that this PR is a quick change to the overall IA of security topics. The detailed content updates and improvements will be continued and reviewed in a follow-up PR.

Documentation
- [x]
doc
- [ ]
doc-required
- [ ]
doc-not-needed
- [ ]
doc-complete
@RobertIndie Thanks for your review and comments. I addressed some of them and will leave the others to the next follow-up PR. Because this PR focuses more on the information architecture changes, and some changes (except the WHAT/WHY in the Overview) are a copy&paste work among topics. A thorough content review will be done in the following week through Google docs to add/change more details and I will invite you as a reviewer :)
@congbobo184 @RobertIndie I've created a Google doc to start the review/revise process on the content and added Zike's comments there. We can collaborate to review/revise in detail there.