Open momo-jun opened 1 year ago
The issue had no activity for 30 days, mark with Stale label.
Hi bot, this PIP is not stale, but on track and in good health. Sorry for not updating it :)
Attached the links to the follow-up doc enhancements implemented by @RobertIndie :
The issue had no activity for 30 days, mark with Stale label.
Motivation
This proposal is focused on refactoring and improving the information architecture of the existing Pulsar client documentation. The benefits it can bring include:
Goal
The following major issues of Client docs can be improved in terms of information architecture.
In a nutshell, keeping the IA as is will make client doc more complex in both reading/consuming and developing/maintaining, especially when it scales with more features/supports added in the future. The goal of this PIP is to tackle this challenge by applying the following strategies:
Implementation
The following figure shows an example of the IA redesign work BEFORE & AFTER.
Key changes
Task Breakdown
Reference