pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

[Doc] Refactor the information architecture and content of Schema

Open momo-jun opened this issue 2 years ago • 3 comments

Search before asking

  • [X] I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

This idea popped up when I was thinking about how to improve the client libraries docs - it's very likely that because we haven't got a robust and structured topic-based authoring model to host the docs for various features, contributors/maintainers don't know what's the proper place to fit the information in so they keep tiling the content in clients' docs, which causes many duplicates and inconsistencies, and somehow isolated and difficult to consume. So I started with Security doc improvements and now Schema.

Schema content is scattered and not easy to read and understand, including:

  1. The overall Information Architecture can be better organized and reused.
  2. Similar to the Security - authentication section, the schema examples and references for multi-language clients can be incorporated into the Schema chapter and only keeps a link in the Client Libraries chapter. ---- also has a dependency on this client doc issue.
  3. Administrative tasks using APIs should be relocated to the Admin Interfaces chapter.
  4. Outdated content needs a revisit and refresh.

What is your suggestion?

  1. Redesign the information architecture through content mapping. The following is an initial thought. Feel free to leave your suggestions regarding schema content, as a user or an expert. image
  2. Improve the content with engineering experts in a follow-up PR.

Any reference?

The applied methodology and expected outcome for refactoring the IA and content are similar to the following chapters:

  • Functions implemented in https://github.com/apache/pulsar/pull/15975
  • Security implemented in
    • https://github.com/apache/pulsar/pull/17615
    • https://github.com/apache/pulsar/pull/17666
    • https://github.com/apache/pulsar/pull/17808
    • https://github.com/apache/pulsar/pull/18035

Are you willing to submit a PR?

  • [X] I'm willing to submit a PR!

Implementation

  • [X] #18242

momo-jun avatar Oct 21 '22 09:10 momo-jun

Ping @congbobo184 @RobertIndie to take a look at the proposal. //cc @Anonymitaet @DaveDuggins @D-2-Ed

momo-jun avatar Oct 27 '22 10:10 momo-jun

what kinds of schema protocol do we support? json, avro, protobuf, thrift?

yuweisung avatar Oct 28 '22 13:10 yuweisung

what kinds of schema protocol do we support? json, avro, protobuf, thrift?

@yuweisung thrift is not supported; for the other three, Yes!

momo-jun avatar Nov 01 '22 05:11 momo-jun