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

DOC-511 Schema CRD #848

Merged
merged 24 commits into from
Nov 22, 2024
Merged

DOC-511 Schema CRD #848

merged 24 commits into from
Nov 22, 2024

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Nov 12, 2024

Description

Adds docs for the new Schema resource.

Do not merge. Waiting on 2.3.0 release of the operator: https://github.com/redpanda-data/redpanda-operator/releases

This resource hasn't yet been released, so the doc's prerequisites include a placeholder for the minimum required version. This placeholder will be replaced with the release version when a release is published.

Review deadline: 15 November

Related:

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Deflaimun and others added 16 commits October 30, 2024 16:22
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
@JakeSCahill JakeSCahill requested a review from a team as a code owner November 12, 2024 12:39
Copy link

netlify bot commented Nov 12, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 99c62c6
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67408b1422d4f20009f14415
😎 Deploy Preview https://deploy-preview-848--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@andrewstucki andrewstucki left a comment

Choose a reason for hiding this comment

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

LGTM other than the placeholders.

Copy link
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

Really just the one comment regarding the Forward compatibility mode to double check, thanks!

* `None`: Disables compatibility checks, allowing any schema change.
* `Backward`: New schemas are backward-compatible with previous versions, ensuring that new consumers can read data created with older schemas.
* `BackwardTransitive`: Enforces backward compatibility across all versions, not just the latest.
* `Forward`: New consumers can process data written with older schemas, allowing forward compatibility.
Copy link
Contributor

Choose a reason for hiding this comment

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

Backward and Forward sound the same - let me know if I misunderstand. Should the Forward description match the one from here? https://deploy-preview-848--redpanda-docs-preview.netlify.app/24.3/manage/schema-reg/schema-reg-api/#configure-schema-compatibility

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks for calling this out

modules/manage/pages/kubernetes/k-schema-controller.adoc Outdated Show resolved Hide resolved

== Schema examples

These examples demonstrate how to define schemas in Avro, Protobuf, and JSON Schema formats.
Copy link
Contributor

Choose a reason for hiding this comment

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

(This probably mostly applies to me, so note to myself:) We should standardize when referring to the schema format - "JSON Schema" is more specific than just "JSON" 👍

modules/manage/pages/kubernetes/k-schema-controller.adoc Outdated Show resolved Hide resolved
modules/manage/pages/kubernetes/k-schema-controller.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

🙌

@JakeSCahill JakeSCahill merged commit 9954263 into v-WIP/24.3 Nov 22, 2024
7 checks passed
@JakeSCahill JakeSCahill deleted the DOC-511 branch November 22, 2024 14:25
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.

5 participants