docs (k8s): Move inline YAML examples to feature files for schema and topic controllers

[david-yu]

Summary

• Extract inline YAML examples from k-schema-controller.adoc (full compatibility schema, schema references) into schema-crds.feature with proper tags and include directives
• Extract inline YAML examples from k-manage-topics.adoc (write caching topic, cleanup policy topic) into topic-crds.feature with proper tags and include directives
• 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

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	b8be944
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/69dce4b7a1638b0008e12302
😎 Deploy Preview	https://deploy-preview-1650--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle 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]

📝 Walkthrough

Walkthrough

Added new Kubernetes example BDD scenarios and updated docs to include them. Three skipped Schema CRD scenarios were added to modules/manage/examples/kubernetes/schema-crds.feature covering full compatibility, backward compatibility, and a schema with a reference to another schema. Two skipped Topic CRD scenarios were added to modules/manage/examples/kubernetes/topic-crds.feature for write caching and delete cleanup policy. Documentation pages (k-manage-topics.adoc and k-schema-controller.adoc) were updated to replace inline YAML examples with AsciiDoc includes referencing the new feature snippets. A small paragraph in the schema-registry ACLs doc was moved for improved placement.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• docs (k8s): add Schema Registry ACLs for Redpanda Operator #1619: Modifies the same ACLs documentation area; related due to overlapping edits in k-schema-registry-acls.adoc.
• auto-docs: Update K8s acceptance tests #1445: Edits the same Kubernetes example feature files (schema-crds.feature and topic-crds.feature); content changes are closely related.

Suggested reviewers

• chrisseto

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description lacks required template sections including a JIRA ticket reference, review deadline, page previews, and check categories.	Add the missing required sections from the template: Resolves link with JIRA ticket, Review deadline, Page previews URLs, and mark appropriate checkboxes (Content gap and Small fix appear relevant).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: moving inline YAML examples from documentation files into feature files for schema and topic controllers.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

modules/manage/pages/kubernetes/k-schema-controller.adoc (1)

188-193: Consider adding documentation about the prerequisite schema.

The included example references a product schema that must exist before applying this manifest:

references:
  - name: product-schema
    subject: product
    version: 1

Consider adding a note before this example explaining that the referenced schema must be created first, similar to how other documentation sections explain prerequisites.

Suggested addition

 Define a schema reference using the `references` field. The reference includes the name, subject, and version of the referenced schema:

+NOTE: The referenced schema (in this case, a schema with subject `product`) must already exist in the Schema Registry before applying a schema that references it.
+
 [,yaml,indent=0]
 ----
 include::manage:example$kubernetes/schema-crds.feature[tags=schema-references-manifest,indent=0]
 ----

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@modules/manage/pages/kubernetes/k-schema-controller.adoc` around lines 188 -
193, Add a short prerequisite note before the YAML example that uses the
references field to explain the referenced schema must exist beforehand;
specifically mention that the example's reference (name: product-schema,
subject: product, version: 1) requires the corresponding product schema to be
created prior to applying this manifest so users know to create that schema
first.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@modules/manage/examples/kubernetes/schema-crds.feature`:
- Around line 142-175: The scenario for Schema named "order-schema" references a
non-existent dependency "product-schema" (subject: "product", version: 1),
causing sync/compatibility to fail; fix by either adding a preceding scenario
that creates the referenced schema (e.g., create a Schema resource named
"product-schema" with subject "product" and version 1 and ensure it's synced
before the order-schema scenario) or change the references block in the
"order-schema" manifest to point to an existing schema in this feature (for
example replace name/subject with the existing "product-catalog" schema and its
correct subject/version) so the reference can be resolved at test time.

In `@modules/manage/examples/kubernetes/topic-crds.feature`:
- Around line 55-79: The topic name "compacted-topic" conflicts with its
configured cleanup.policy of "delete"; fix this by either renaming the Topic
metadata.name from "compacted-topic" to a name matching the delete semantics
(e.g., "retained-topic" or "delete-policy-topic") or change
spec.additionalConfig.cleanup.policy from "delete" to "compact" so the name and
policy align; update the Scenario text and any referenced steps that mention
"compacted-topic" to the new name to keep the test consistent.

---

Nitpick comments:
In `@modules/manage/pages/kubernetes/k-schema-controller.adoc`:
- Around line 188-193: Add a short prerequisite note before the YAML example
that uses the references field to explain the referenced schema must exist
beforehand; specifically mention that the example's reference (name:
product-schema, subject: product, version: 1) requires the corresponding product
schema to be created prior to applying this manifest so users know to create
that schema first.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cf33fb5c-a968-4f11-81fb-b1b9c3a24cd6

📥 Commits

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

📒 Files selected for processing (5)

• modules/manage/examples/kubernetes/schema-crds.feature
• modules/manage/examples/kubernetes/topic-crds.feature
• 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

[JakeSCahill]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.