Anonymitaet commented on PR #12536:
URL: https://github.com/apache/pulsar/pull/12536#issuecomment-1482185422
Hi @madhavan-narayanan, thanks for your great contribution!
I see you marked this PR with the `doc-required` label, but the doc has not
been added yet.
To figure out what content we should add, we (+@hangc0276) have gone through
the PR changes and figured out the general idea (it adds some inceptors to
brokers to better process messages), but we do not know the details.
Since you're the author, can you please add docs or provide technical
inputs?
====================
To help you quickly get started, here are some thoughts on doc inputs:
1. Highly-level structure
How about adding a new topic in [Development > Plugin >
Interceptor](https://github.com/apache/pulsar/issues/13585) and [putting the
docs there](https://pulsar.apache.org/docs/next/developers-landing/)?
2. Specific topics
To help devs use this new feature smoothly, consider taking the
following doc elements into consideration:
- **Who** (Developers)
- **What** (What is this? What features does it provide? → Overview)
- **Why** (What are the benefits of using this feature? → Use Case)
- **When** (When to use it? Any considerations or limitations?)
- **How** (How to use it? → Tutorials (e.g., Get Started) / How-to
Guides / Interface Reference doc)
You can take [Pulsar Admin API
doc](https://pulsar.apache.org/docs/next/admin-api-overview/) as a reference
and template. Thank you!
====================
cc @D-2-Ed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
