Skip to content

Move inline YAML examples to feature files for schema and topic controllers#1649

Closed
david-yu wants to merge 33 commits intoredpanda-data:mainfrom
david-yu:docs/schema-registry-acls-operator
Closed

Move inline YAML examples to feature files for schema and topic controllers#1649
david-yu wants to merge 33 commits intoredpanda-data:mainfrom
david-yu:docs/schema-registry-acls-operator

Conversation

@david-yu
Copy link
Copy Markdown
Contributor

@david-yu david-yu commented Apr 1, 2026

Summary

  • Extract 2 inline YAML examples from k-schema-controller.adoc (full compatibility schema, schema references) into schema-crds.feature with proper tags and include directives
  • Extract 2 inline YAML examples from k-manage-topics.adoc (write caching topic, cleanup policy topic) into topic-crds.feature with proper tags and include directives
  • This ensures all concrete YAML examples follow the same pattern: stored in feature files for testability, included via tags in documentation

Test plan

  • Verify the schema controller page renders correctly with the included examples
  • Verify the manage topics page renders correctly with the included examples
  • Confirm feature file tags are properly extracted in the Antora build

🤖 Generated with Claude Code

Feediver1 and others added 30 commits February 21, 2026 20:35
Co-authored-by: Gellért Peresztegi-Nagy <gellert.nagy@redpanda.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Add documentation for managing Schema Registry ACLs using the Redpanda
Operator's User, RedpandaRole, and Group custom resources. This covers
the new `subject` and `registry` ACL resource types added in operator
PR redpanda-data/redpanda-operator#1306.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ta#1598)

Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
…ma-registry-acls.adoc

Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
…ma-registry-acls.adoc

Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
The operations list is already linked from the line above, so the
subsection was duplicating content from the Schema Registry
Authorization page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Document the new monitoring.enabled, monitoring.scrapeInterval, and
monitoring.labels Helm values that deploy a ServiceMonitor resource
alongside Console for automatic Prometheus discovery.

Relates to redpanda-data/redpanda-operator#1056

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add page-topic-type and personas metadata
- Trim description to under 155 chars
- Replace repeated "Ensure" in prerequisites with noun-led format
- Replace "You can add" openers with direct statements
- Fix "the Redpanda Schema Registry" -> "Schema Registry"
- Trim "For details about" verbose opener
- Rename "Suggested reading" to "Next steps"

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The include directive for group-crds.feature was missing, causing the
code block not to render on the deploy preview.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The doc page describes both topic and subject ACLs in the examples,
but the feature files only had topic ACLs. Add the missing subject
ACL entries to match the documentation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move the explanatory text from after the code blocks to before them
so it serves as intro text for each subsection.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Extract the three inline YAML examples from the Common use cases section
into tagged scenarios in user-crds.feature so they are testable. Revert
unrelated changes to the Console deploy page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…fixes (redpanda-data#1630)

Co-authored-by: micheleRP <michele@redpanda.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…#1640)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…#1595)

Co-authored-by: Nicolae Vartolomei <nv@redpanda.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Kat Batuigas <kbatuigas@gmail.com>
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
- Merge all commits from main (20 commits)
- Resolve conflicts: keep v-WIP/26.1 version and release notes
- Update antora.yml with v26.1.1 release information:
  - latest-redpanda-tag: v26.1.1
  - latest-release-commit: 35a825c9c1880ebeedf4c18bb8c6cceaa63566c1
  - full-version: 26.1.1
  - page-release-date: 2026-03-31

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…da-data#1627)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: micheleRP <michele@redpanda.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
…_time (redpanda-data#1607)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: JakeSCahill <jake@redpanda.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: JakeSCahill <jake@redpanda.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
david-yu and others added 3 commits March 31, 2026 14:01
…edpanda-data#1628)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: micheleRP <michele@redpanda.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
…ollers

Extract inline examples from k-schema-controller.adoc (full compatibility
schema, schema references) and k-manage-topics.adoc (write caching topic,
cleanup policy topic) into their respective feature files with proper tags
so they follow the same include pattern as existing examples.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@david-yu david-yu requested a review from a team as a code owner April 1, 2026 16:07
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

Deploy Preview for redpanda-docs-preview ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f8e839b
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69cd42c2bd7fc10008ebb546
😎 Deploy Preview https://deploy-preview-1649--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 project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cf7fdfb5-ead2-44a4-8622-88ffd76669d4

📥 Commits

Reviewing files that changed from the base of the PR and between c4f9842 and f8e839b.

📒 Files selected for processing (71)
  • antora.yml
  • docs-data/property-overrides.json
  • docs-data/redpanda-property-changes-v25.3.1-to-v25.3.3.json
  • docs-data/redpanda-property-changes-v25.3.7-to-v26.1.1-rc2.json
  • modules/ROOT/nav.adoc
  • modules/console/pages/ui/edit-topic-configuration.adoc
  • modules/deploy/pages/console/kubernetes/deploy.adoc
  • modules/deploy/pages/redpanda/manual/production/dev-deployment.adoc
  • modules/deploy/partials/high-availability.adoc
  • modules/develop/pages/kafka-clients.adoc
  • modules/develop/pages/manage-topics/cloud-topics.adoc
  • modules/develop/pages/manage-topics/config-topics.adoc
  • modules/develop/pages/manage-topics/index.adoc
  • modules/develop/pages/produce-data/configure-producers.adoc
  • modules/develop/pages/produce-data/leader-pinning.adoc
  • modules/get-started/pages/quick-start.adoc
  • modules/get-started/pages/release-notes/helm-charts.adoc
  • modules/get-started/pages/release-notes/operator.adoc
  • modules/get-started/pages/release-notes/redpanda.adoc
  • modules/manage/examples/kubernetes/group-crds.feature
  • modules/manage/examples/kubernetes/role-crds.feature
  • modules/manage/examples/kubernetes/schema-crds.feature
  • modules/manage/examples/kubernetes/topic-crds.feature
  • modules/manage/examples/kubernetes/user-crds.feature
  • modules/manage/pages/audit-logging/audit-log-samples.adoc
  • modules/manage/pages/cluster-maintenance/about-throughput-quotas.adoc
  • modules/manage/pages/cluster-maintenance/compaction-settings.adoc
  • modules/manage/pages/cluster-maintenance/continuous-data-balancing.adoc
  • modules/manage/pages/cluster-maintenance/decommission-brokers.adoc
  • modules/manage/pages/cluster-maintenance/disk-utilization.adoc
  • modules/manage/pages/cluster-maintenance/manage-throughput.adoc
  • modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc
  • modules/manage/pages/iceberg/about-iceberg-topics.adoc
  • modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc
  • modules/manage/pages/iceberg/iceberg-topics-databricks-unity.adoc
  • modules/manage/pages/iceberg/query-iceberg-topics.adoc
  • modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc
  • modules/manage/pages/iceberg/specify-iceberg-schema.adoc
  • modules/manage/pages/iceberg/use-iceberg-catalogs.adoc
  • modules/manage/pages/kubernetes/k-cloud-topics.adoc
  • modules/manage/pages/kubernetes/k-decommission-brokers.adoc
  • modules/manage/pages/kubernetes/k-manage-topics.adoc
  • modules/manage/pages/kubernetes/k-schema-controller.adoc
  • modules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adoc
  • modules/manage/pages/security/authorization/acl.adoc
  • modules/manage/pages/security/authorization/gbac.adoc
  • modules/manage/pages/security/authorization/index.adoc
  • modules/manage/pages/security/fips-compliance.adoc
  • modules/manage/partials/audit-logging.adoc
  • modules/manage/partials/authentication.adoc
  • modules/manage/partials/gbac-assign-group-role.adoc
  • modules/manage/partials/gbac-create-group-acl.adoc
  • modules/manage/partials/gbac-dp.adoc
  • modules/manage/partials/remote-read-replicas.adoc
  • modules/manage/partials/tiered-storage.adoc
  • modules/reference/attachments/redpanda-properties-v26.1.1-rc2.json
  • modules/reference/pages/properties/cluster-properties.adoc
  • modules/reference/pages/properties/topic-properties.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc
  • modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc
  • modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc
  • modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc
  • modules/reference/partials/deprecated/deprecated-properties.adoc
  • modules/reference/partials/properties/broker-properties.adoc
  • modules/reference/partials/properties/cluster-properties.adoc
  • modules/reference/partials/properties/object-storage-properties.adoc
  • modules/reference/partials/properties/topic-properties.adoc
  • modules/reference/partials/properties/topic-property-mappings.adoc
  • modules/shared/partials/tristate-behavior-change-25-3.adoc
  • modules/upgrade/pages/k-compatibility.adoc
  • modules/upgrade/partials/incompat-changes.adoc

Disabled knowledge base sources:

  • Jira integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

This pull request represents a major documentation release update for Redpanda v26.1, introducing new features and restructuring documentation. Changes include: bumping Antora metadata (version 25.3 to 26.1, release dates, and fallback Redpanda references), clearing prerelease beta fields, adding 26 new configuration properties with version v26.1.1-rc2 metadata, removing outdated property comparison files, reorganizing the navigation structure to introduce a manage-topics section, and adding comprehensive documentation for new features including Cloud Topics, Group-Based Access Control (GBAC), FIPS compliance, and Kubernetes enhancements. Additionally, numerous cross-references throughout documentation are updated to point to new page locations, and multiple Kubernetes CRD test examples are added covering group/role/schema/topic/user resource scenarios.

Sequence Diagram(s)

Diagrams are not applicable to this pull request, as the changes are primarily documentation, configuration metadata, and test examples. The updates do not introduce new features with multi-component interactions or altered control flows that would benefit from sequence visualization.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

Possibly related PRs

Suggested reviewers

  • JakeSCahill
  • micheleRP
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch docs/schema-registry-acls-operator

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@david-yu david-yu closed this Apr 1, 2026
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.

8 participants