Skip to content

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

Merged
Anonymitaet merged 3 commits into
apache:masterfrom
momo-jun:schema-compatibility-strategy-topic-level
Jan 31, 2022
Merged

[Doc] Add content for topic-level schema compatibility check strategy#13832
Anonymitaet merged 3 commits into
apache:masterfrom
momo-jun:schema-compatibility-strategy-topic-level

Conversation

@momo-jun

@momo-jun momo-jun commented Jan 19, 2022

Copy link
Copy Markdown
Contributor

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
Copy Markdown

@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
Copy Markdown

@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
Copy Markdown
Contributor Author

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

Comment thread site2/docs/schema-manage.md Outdated

<!--DOCUSAURUS_CODE_TABS-->

<!--admin CLI-->

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.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.


- 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
Copy Markdown
Member

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
Copy Markdown
Contributor Author

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.

Comment thread site2/docs/schema-manage.md Outdated

<!--DOCUSAURUS_CODE_TABS-->

<!--admin CLI-->

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.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.

Comment thread site2/docs/schema-manage.md Outdated

<!--DOCUSAURUS_CODE_TABS-->

<!--admin CLI-->

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.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Corrected. PTAL. Thanks.

<!--END_DOCUSAURUS_CODE_TABS-->


### Namespace level

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.

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

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes.

Copy link
Copy Markdown
Contributor Author

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

@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
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.

3 participants