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

[improve][doc] Add a document of schema compatibility between Java and Go #1056

Closed
wants to merge 2 commits into from

Conversation

liangyepianzhou
Copy link
Contributor

Motivation

Master #1031.

Modifications

Add a file to explain the schema compatibility and solutions.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end deployment with large payloads (10MB)
  • Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API: (yes / no)
  • The schema: (yes / no / don't know)
  • The default values of configurations: (yes / no)
  • The wire protocol: (yes / no)

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / GoDocs / not documented)
  • If a feature is not applicable for documentation, explain why?
  • If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

@shibd
Copy link
Member

shibd commented Jul 17, 2023

@liangyepianzhou Hi, Why didn't we add this doc to the Pulsar website?

I think we can add a new doc (Schema compatibility between clients) on this:
image

@Anonymitaet, Can you take a look at it?

README.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
docs/schema-compatibility.md Outdated Show resolved Hide resolved
@liangyepianzhou
Copy link
Contributor Author

@liangyepianzhou Hi, Why didn't we add this doc to the Pulsar website?

I think we can add a new doc (Schema compatibility between clients) on this: image

@Anonymitaet, Can you take a look at it?

IMO, this is a schema compatibility documentation written specifically for the GO language. It mainly writes how GO should adjust the schema to be compatible with JAVA. So it is better to write it in the GO documentation.

@Anonymitaet
Copy link
Member

Anonymitaet commented Jul 18, 2023

@liangyepianzhou @shibd does it make sense to locate the docs to https://pulsar.apache.org/docs/next/client-libraries-schema/? Reasons:

  • It's related to both clients and schema.
  • It has higher visibility than docs in Go readme. Users are more likey to read docs on the Pulsar website.

@shibd
Copy link
Member

shibd commented Jul 18, 2023

Yes, I think put it to https://pulsar.apache.org/docs/next/client-libraries-schema/ is better.

@RobertIndie
Copy link
Member

What's the status of this PR? Will you put this doc to the pulsar-site instead of this repo?

@liangyepianzhou
Copy link
Contributor Author

@liangyepianzhou @shibd does it make sense to locate the docs to https://pulsar.apache.org/docs/next/client-libraries-schema/? Reasons:

  • It's related to both clients and schema.
  • It has higher visibility than docs in Go readme. Users are more likey to read docs on the Pulsar website.

It makes sense to me. Thanks for your suggestion. @shibd @Anonymitaet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants