Skip to content

Conversation

@freeznet
Copy link
Member

@freeznet freeznet commented Jul 3, 2025

(If this PR fixes a github issue, please add Fixes #<xyz>.)

Fixes #

(or if this PR is one task of a github issue, please add Master Issue: #<xyz> to link to the master issue.)

Master Issue: #

Motivation

Explain here the context, and why you're making that change. What is the problem you're trying to solve.

Modifications

Describe the modifications you've done.

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

Documentation

Check the box below.

Need to update docs?

  • doc-required

    (If you need help on updating docs, create a doc issue)

  • no-need-doc

    (Please explain why)

  • doc

    (If this PR contains doc changes)

@freeznet freeznet self-assigned this Jul 3, 2025
@freeznet freeznet requested review from a team as code owners July 3, 2025 16:35
@github-actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025

@freeznet: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 the doc-info-missing This pr needs to mark a document option in description label Jul 3, 2025
@freeznet freeznet changed the title fix namespace docs and annotations fix namespace and topic docs / CRDs Jul 4, 2025
@freeznet freeznet requested a review from Copilot July 4, 2025 01:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the Pulsar topic and namespace documentation to align with new schema formats and expands the namespace CRD and API enums to support additional compatibility strategies.

  • Clarified the schema field format in pulsar_topic.md
  • Expanded and renamed schema compatibility options in pulsar_namespace.md, CRD YAML, and Go types
  • Adjusted kubebuilder validation enums in the PulsarNamespaceSpec Go struct

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/pulsar_topic.md Updated schema table entry to specify JSON string usage
docs/pulsar_namespace.md Replaced strategy names with new uppercase values and updated descriptions and examples
config/crd/bases/resource.streamnative.io_pulsarnamespaces.yaml Replaced old enum entries with new compatibility strategy values
api/v1alpha1/pulsarnamespace_types.go Updated kubebuilder:validation:Enum to include new strategy values
Comments suppressed due to low confidence (1)

docs/pulsar_namespace.md:107

  • Restore consistent indentation in the YAML code examples (e.g., re-add leading spaces before schemaCompatibilityStrategy) to maintain proper formatting within the code blocks.
schemaCompatibilityStrategy: ALWAYS_COMPATIBLE

@freeznet freeznet merged commit f199633 into main Jul 4, 2025
6 checks passed
@freeznet freeznet deleted the freeznet/fix-ns-docs branch July 4, 2025 04:58
freeznet added a commit that referenced this pull request Jul 4, 2025
* fix ns docs

* update topic schema doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-info-missing This pr needs to mark a document option in description

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants