Skip to content

[refactor][doc] Improve schema docs - #18434

Merged
momo-jun merged 22 commits into
apache:masterfrom
momo-jun:schema-content-improvement
Dec 14, 2022
Merged

[refactor][doc] Improve schema docs#18434
momo-jun merged 22 commits into
apache:masterfrom
momo-jun:schema-content-improvement

Conversation

@momo-jun

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

Copy link
Copy Markdown
Contributor

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

@labuladong labuladong left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread site2/docs/schema-understand.md Outdated
Comment thread site2/docs/schema-get-started.md
Comment thread site2/docs/schema-get-started.md
Comment thread site2/docs/schema-get-started.md
Comment thread site2/docs/schema-get-started.md
Comment thread site2/docs/schema-get-started.md Outdated
Comment thread site2/docs/schema-get-started.md Outdated
Comment thread site2/docs/schema-get-started.md
Comment thread site2/docs/schema-get-started.md
@momo-jun
momo-jun requested a review from RobertIndie November 29, 2022 02:40
@momo-jun

Copy link
Copy Markdown
Contributor Author

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

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

@RobertIndie RobertIndie left a comment

Copy link
Copy Markdown
Member

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.

Comment thread site2/docs/schema-understand.md Outdated
Comment thread site2/docs/schema-understand.md
Comment thread site2/docs/schema-understand.md Outdated
Comment thread site2/docs/schema-understand.md Outdated
Comment thread site2/docs/schema-understand.md Outdated
Comment thread site2/docs/schema-understand.md Outdated
Comment thread site2/docs/schema-understand.md Outdated
@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
Comment thread site2/docs/schema-get-started.md Outdated
Comment thread site2/docs/admin-api-schemas.md Outdated
Comment thread site2/docs/admin-api-schemas.md Outdated
Comment thread site2/docs/schema-get-started.md Outdated
Comment thread site2/docs/schema-get-started.md Outdated
@momo-jun

Copy link
Copy Markdown
Contributor Author

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

@RobertIndie RobertIndie left a comment

Copy link
Copy Markdown
Member

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.

@labuladong labuladong left a comment

Copy link
Copy Markdown
Contributor

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