Skip to content

[Doc] Add content for topic-level schema compatibility check strategy #13832

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.

Sign up for GitHub

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

Jump to bottom
Merged
Anonymitaet merged 3 commits into from
Jan 31, 2022
Merged

[Doc] Add content for topic-level schema compatibility check strategy #13832

Anonymitaet merged 3 commits into from
Jan 31, 2022

Conversation

@momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Jan 19, 2022 •
edited
Loading

Doc updates for #13297.

Modifications

  1. Simplify the description of strategy priority set at different levels.
    image

  2. Add set/get/remove methods for topic-level schema compatibility check strategy in three ways.
    2.1) admin CLI
    image

2.2) Rest API
image

2.3) Java Admin API
image
image

Documentation

  • doc

@github-actions
Copy link

github-actions bot commented Jan 19, 2022

@momo-jun:Thanks for your contribution. For this PR, do we need to update docs?
(The PR template contains info about doc, which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)

@github-actions github-actions bot added doc-label-missing doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-label-missing labels Jan 19, 2022
@github-actions
Copy link

github-actions bot commented Jan 19, 2022

@momo-jun:Thanks for providing doc info!

@momo-jun momo-jun marked this pull request as ready for review January 29, 2022 03:31
@momo-jun
Copy link
Contributor Author

momo-jun commented Jan 29, 2022

Hi @nodece @codelipenghui @Anonymitaet Can you pls review this doc PR? Thanks.

nodece
nodece reviewed Jan 29, 2022
View reviewed changes
site2/docs/schema-manage.md Outdated

<!--DOCUSAURUS_CODE_TABS-->

<!--admin CLI-->
Copy link
Member

@nodece nodece Jan 29, 2022

Choose a reason for hiding this comment

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

Suggested change
<!--admin CLI-->
<!--Admin CLI-->

Copy link
Contributor Author

@momo-jun momo-jun Jan 29, 2022

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.

nodece
nodece reviewed Jan 29, 2022
View reviewed changes
site2/docs/schema-manage.md

- If you set schema compatibility check strategy at namespace level rather than broker level, it uses the strategy set for the namespace level.
- If you do not set the strategy at any level, it uses the `FULL` strategy.

Copy link
Member

@nodece nodece Jan 29, 2022

Choose a reason for hiding this comment

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

Could you add a description that available values for schema compatibility strategy?

Copy link
Contributor Author

@momo-jun momo-jun Jan 29, 2022

Choose a reason for hiding this comment

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

Good point. I will add a link as the reference for available values. Thank you.

nodece
nodece reviewed Jan 29, 2022
View reviewed changes
site2/docs/schema-manage.md Outdated

<!--DOCUSAURUS_CODE_TABS-->

<!--admin CLI-->
Copy link
Member

@nodece nodece Jan 29, 2022

Choose a reason for hiding this comment

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

Suggested change
<!--admin CLI-->
<!--Admin CLI-->

Copy link
Contributor Author

@momo-jun momo-jun Jan 29, 2022

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.

nodece
nodece reviewed Jan 29, 2022
View reviewed changes
site2/docs/schema-manage.md Outdated

<!--DOCUSAURUS_CODE_TABS-->

<!--admin CLI-->
Copy link
Member

@nodece nodece Jan 29, 2022

Choose a reason for hiding this comment

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

Suggested change
<!--admin CLI-->
<!--Admin CLI-->

Copy link
Contributor Author

@momo-jun momo-jun Jan 29, 2022

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.

nodece
nodece reviewed Jan 29, 2022
View reviewed changes
site2/docs/schema-manage.md
<!--END_DOCUSAURUS_CODE_TABS-->


### Namespace level
Copy link
Member

@nodece nodece Jan 29, 2022

Choose a reason for hiding this comment

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

We should keep the DOCUSAURUS_CODE_TABS tab has same style between Topice level and Namespace level.

Copy link
Contributor Author

@momo-jun momo-jun Jan 29, 2022

Choose a reason for hiding this comment

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

We should keep the DOCUSAURUS_CODE_TABS tab has same style between Topice level and Namespace level.

Do you mean by using the same tab name, like Admin CLI?

Copy link
Member

@nodece nodece Jan 29, 2022

Choose a reason for hiding this comment

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

Yes.

Copy link
Contributor Author

@momo-jun momo-jun Jan 29, 2022

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.

nodece
nodece approved these changes Jan 29, 2022
View reviewed changes
Copy link
Member

@nodece nodece left a comment

Choose a reason for hiding this comment

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

LGTM

@momo-jun momo-jun changed the title [Doc] Initial commit for topic-level schema compatibility check strategy [Doc] Add content for topic-level schema compatibility check strategy Jan 29, 2022
@Anonymitaet Anonymitaet added this to the 2.10.0 milestone Jan 31, 2022
@Anonymitaet Anonymitaet merged commit f71c350 into apache:master Jan 31, 2022
Nicklee007 pushed a commit to Nicklee007/pulsar that referenced this pull request Apr 20, 2022
@momo-jun
[Doc] Add content for topic-level schema compatibility check strategy (…
b75ea55 
…apache#13832)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nodece nodece nodece approved these changes

@Anonymitaet Anonymitaet Anonymitaet approved these changes

Assignees

@momo-jun momo-jun

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Milestone

2.10.0

Development

Successfully merging this pull request may close these issues.

3 participants

@momo-jun @nodece @Anonymitaet