Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Refactor the information architecture and content of Schema #18151

Closed
3 tasks done
momo-jun opened this issue Oct 21, 2022 · 3 comments · Fixed by #18242
Closed
3 tasks done

[Doc] Refactor the information architecture and content of Schema #18151

momo-jun opened this issue Oct 21, 2022 · 3 comments · Fixed by #18242
Assignees
Labels
doc-required Your PR changes impact docs and you will update later.

Comments

@momo-jun
Copy link
Contributor

momo-jun commented Oct 21, 2022

Search before asking

  • 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:

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Implementation

@momo-jun momo-jun added the doc-required Your PR changes impact docs and you will update later. label Oct 21, 2022
@momo-jun momo-jun self-assigned this Oct 21, 2022
@momo-jun
Copy link
Contributor Author

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

@yuweisung
Copy link

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

@momo-jun
Copy link
Contributor Author

momo-jun commented Nov 1, 2022

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required Your PR changes impact docs and you will update later.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants