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

[refactor][doc] Improve schema docs #18434

Merged
merged 22 commits into from
Dec 14, 2022

Conversation

momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Nov 11, 2022

Motivation

This is a follow-up PR to #18242 to improve the Schema docs, aiming to provide Pulsar users with a more accurate, easy-to-read, and comprehensive information experience.

Modifications

The content is revised and reviewed through Google docs.

  1. Improve the description and illustrations of How Pulsar schema works.
  2. Add an illustration to introduce Pulsar schema.
  3. Incorporate schema evolution and subtopics into Understand schema.
  4. Relocate native Avro to struct schema.
  5. Add incremental changes to align with the code.
  6. Add/correct descriptions, commands, and code examples, e.g., fixing [Doc] Java client examples for protobuf native schema #15035
  7. Remove duplicate or redundant information.

Many thanks to @congbobo184, @liangyepianzhou and @RobertIndie for providing technical inputs and review comments.

//cc @Anonymitaet @DaveDuggins @D-2-Ed

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@momo-jun momo-jun self-assigned this Nov 11, 2022
@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Nov 11, 2022
@tisonkun tisonkun mentioned this pull request Nov 21, 2022
4 tasks
@momo-jun momo-jun marked this pull request as ready for review November 28, 2022 09:07
Copy link
Contributor

@labuladong labuladong left a comment

Choose a reason for hiding this comment

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

Thanks for your work! Leave some style suggestions in the comments.

site2/docs/schema-understand.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
@momo-jun momo-jun requested a review from RobertIndie November 29, 2022 02:40
@momo-jun
Copy link
Contributor Author

@labuladong thanks for your review. Comments have been addressed. PTAL.

@congbobo184 @liangyepianzhou @RobertIndie Do you have any other review comments?

Copy link
Member

@RobertIndie RobertIndie left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! I left some comments here.

site2/docs/schema-understand.md Outdated Show resolved Hide resolved
site2/docs/schema-understand.md Show resolved Hide resolved
site2/docs/schema-understand.md Outdated Show resolved Hide resolved
site2/docs/schema-understand.md Outdated Show resolved Hide resolved
site2/docs/schema-understand.md Outdated Show resolved Hide resolved
site2/docs/schema-understand.md Outdated Show resolved Hide resolved
site2/docs/schema-understand.md Outdated Show resolved Hide resolved
@momo-jun momo-jun requested a review from RobertIndie December 9, 2022 02:18
@momo-jun momo-jun requested a review from Anonymitaet December 12, 2022 08:15
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/admin-api-schemas.md Outdated Show resolved Hide resolved
site2/docs/admin-api-schemas.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
site2/docs/schema-get-started.md Outdated Show resolved Hide resolved
@momo-jun
Copy link
Contributor Author

@RobertIndie @labuladong Thanks very much for your concrete review. Comments have been addressed. PTAL.

Copy link
Member

@RobertIndie RobertIndie left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for your great work.

Copy link
Contributor

@labuladong labuladong left a comment

Choose a reason for hiding this comment

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

Looks good to me~

@momo-jun momo-jun merged commit fdba644 into apache:master Dec 14, 2022
lifepuzzlefun pushed a commit to lifepuzzlefun/pulsar that referenced this pull request Jan 10, 2023
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.

5 participants