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] Add docs for ProtobufNative Schema #9079

Merged
merged 2 commits into from
Dec 30, 2020
Merged

[Doc] Add docs for ProtobufNative Schema #9079

merged 2 commits into from
Dec 30, 2020

Conversation

Anonymitaet
Copy link
Member

Add docs based on #8372 and update the green-highlighted parts.
schema doc architecture

@Anonymitaet
Copy link
Member Author

@congbobo184 could u pls help review? Thank you.

Copy link
Contributor

@congbobo184 congbobo184 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

* to use different serialization/deserialization methods to handle data
|Type|Description|
---|---|
`AvroBaseStructSchema`|Pulsar uses [Avro Specification](http://avro.apache.org/docs/current/spec.html) to declare the schema definition for `AvroBaseStructSchema`, which supports `AvroSchema`, `JsonSchema`, and `ProtobufSchema`. <br><br>This allows Pulsar:<br>- to use same tools to manage schema definitions<br>- to use different serialization or deserialization methods to handle data|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... to use the same tools...

There are two methods to use `struct` schema:
##### Usage

Pulsar provides three methods to use the `struct` schema:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, it's 100% correct.
I suggest that we use "Pulsar provides the following methods to ...."
When people add more methods below, they usually forget to update the specific number.

@Anonymitaet
Copy link
Member Author

@jennifer88huang thanks for your suggestions. I've incorporated your comments, PTAL.

@sijie sijie added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Dec 30, 2020
@sijie sijie added this to the 2.8.0 milestone Dec 30, 2020
@sijie sijie merged commit 2981152 into apache:master Dec 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants