DOC-1326 update metadata in docs single sourcing

[micheleRP]

Description

This pull request standardizes the placement of the // tag::single-source[] comment across multiple documentation files. The comment was moved to immediately follow the :description: attribute in all affected files. Single sourcing correction in cloud-docs is done in redpanda-data/cloud-docs#284.

Resolves https://redpandadata.atlassian.net/browse/DOC-1326
Review deadline:

Page previews

https://deploy-preview-1114--redpanda-docs-preview.netlify.app/current/develop/

Checks

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

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes involve repositioning the // tag::single-source[] marker in multiple AsciiDoc documentation files. In each case, the marker is moved from before the :description: attribute to immediately after it, or in some cases, from within conditional blocks to the top-level metadata. No content, logic, or structure of the documentation has been changed apart from the placement of this marker and the unconditional exposure of some metadata attributes. The adjustments standardize the order of metadata attributes and markers across the documentation files.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure :description: attribute is not included in single sourcing (DOC-1326)	✅
Standardize the order and placement of metadata attributes and single-source tags (DOC-1326)	✅

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a320e86 and 9901c46.

📒 Files selected for processing (19)

• modules/develop/pages/config-topics.adoc (1 hunks)
• modules/develop/pages/consume-data/consumer-offsets.adoc (1 hunks)
• modules/develop/pages/consume-data/follower-fetching.adoc (1 hunks)
• modules/develop/pages/http-proxy.adoc (1 hunks)
• modules/develop/pages/kafka-clients.adoc (1 hunks)
• modules/develop/pages/produce-data/configure-producers.adoc (1 hunks)
• modules/develop/pages/produce-data/idempotent-producers.adoc (1 hunks)
• modules/develop/pages/produce-data/leader-pinning.adoc (1 hunks)
• modules/develop/pages/transactions.adoc (1 hunks)
• modules/get-started/pages/architecture.adoc (1 hunks)
• modules/get-started/pages/broker-admin.adoc (1 hunks)
• modules/get-started/pages/config-rpk-profile.adoc (1 hunks)
• modules/get-started/pages/intro-to-events.adoc (1 hunks)
• modules/get-started/pages/intro-to-rpk.adoc (1 hunks)
• modules/get-started/pages/partner-integration.adoc (1 hunks)
• modules/get-started/pages/rpk-install.adoc (1 hunks)
• modules/manage/pages/schema-reg/schema-reg-api.adoc (1 hunks)
• modules/manage/pages/schema-reg/schema-reg-overview.adoc (1 hunks)
• modules/reference/pages/public-metrics-reference.adoc (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules - redpanda-docs-preview
• GitHub Check: Header rules - redpanda-docs-preview
• GitHub Check: Pages changed - redpanda-docs-preview

🔇 Additional comments (20)

modules/get-started/pages/config-rpk-profile.adoc (1)

3-4: Approve repositioning of :description: and single-source marker.

The :description: attribute is now unconditionally declared before the // tag::single-source[] marker, which aligns with the standardized metadata ordering across docs. This ensures the description appears in both cloud and non-cloud builds and keeps the single-source tag consistently placed immediately after metadata.

modules/get-started/pages/broker-admin.adoc (1)

3-4: Metadata consistency: move description before conditional block

The :description: attribute is now unconditional, ensuring it’s always rendered regardless of the environment. The // tag::single-source[] marker correctly follows immediately after the description, aligning with the single-sourcing convention. Please verify that extracting the description from the ifdef::env-cloud block does not introduce any unintended differences in your cloud-specific build pipeline.

modules/develop/pages/consume-data/follower-fetching.adoc (1)

4-4: Single-source tag repositioned correctly.
The // tag::single-source[] marker now directly follows the :description: metadata field, matching the standard applied across documentation. No content was altered.

modules/manage/pages/schema-reg/schema-reg-overview.adoc (1)

5-5: Consistent metadata tagging.
The // tag::single-source[] marker is correctly placed immediately after the :description: line, ensuring uniformity with other AsciiDoc pages.

modules/get-started/pages/partner-integration.adoc (1)

4-4: Metadata tag placement is aligned.
The single-source tag follows the :description: attribute as intended, improving consistency across the docs.

modules/develop/pages/config-topics.adoc (1)

5-5: Single-source marker correctly moved.
The // tag::single-source[] now immediately follows the :description:, matching the PR’s objective for metadata consistency.

modules/get-started/pages/intro-to-events.adoc (1)

5-5: Unified placement of single-source tag.
The marker is placed right after the :description: line, consistent with the pattern applied throughout the documentation.

modules/reference/pages/public-metrics-reference.adoc (1)

2-3: Moved single-source tag for metadata consistency
The // tag::single-source[] marker is now correctly positioned immediately after the :description: field, matching the standardized pattern across all AsciiDoc docs. No content or semantic changes introduced.

modules/get-started/pages/intro-to-rpk.adoc (1)

3-4: Repositioned single-source tag after description
The // tag::single-source[] marker follows the :description: metadata as intended, ensuring uniform metadata ordering. No other text or behavior is modified.

modules/develop/pages/produce-data/configure-producers.adoc (1)

4-5: Standardized placement of single-source tag
The // tag::single-source[] comment now immediately follows the :description: line, aligning with the project's metadata conventions. All content remains unchanged.

modules/get-started/pages/architecture.adoc (1)

4-5: Aligned single-source tag with metadata block
The marker is correctly moved to follow the :description: attribute in the frontmatter, standardizing the header format. No semantic impact.

modules/develop/pages/http-proxy.adoc (1)

5-6: Adjusted single-source marker position
The // tag::single-source[] tag is now right after :description:, consistent with other documentation files. No other content is affected.

modules/develop/pages/transactions.adoc (1)

5-5: Consistent tag placement
The // tag::single-source[] marker is now correctly positioned immediately after the :description: metadata, aligning with the standardized pattern across the docs.

modules/develop/pages/produce-data/idempotent-producers.adoc (1)

5-5: Consistent tag placement
The // tag::single-source[] marker has been correctly moved to follow the :description: attribute, improving uniformity across AsciiDoc headers.

modules/manage/pages/schema-reg/schema-reg-api.adoc (2)

4-4: Consistent tag placement
The // tag::single-source[] marker now immediately follows the :description: metadata, matching the pattern applied elsewhere.

---

60-67: Inconsistent summary: unexpected content additions
The PR description and AI summary state that only the single-source tag was relocated, but new instructional content was added starting at line 60 (setup notes and alternative rpk usage). Please confirm whether these additions were intentional and within scope.

Likely an incorrect or invalid review comment.

modules/develop/pages/produce-data/leader-pinning.adoc (1)

3-3: Consistent tag placement
The // tag::single-source[] marker is correctly positioned immediately after the :description: metadata, maintaining consistent header formatting.

modules/get-started/pages/rpk-install.adoc (1)

4-4: Consistent description and tag order
The :description: attribute is now placed immediately before the // tag::single-source[] comment, standardizing the metadata ordering across the documentation.

modules/develop/pages/consume-data/consumer-offsets.adoc (1)

5-5: Metadata marker relocation is consistent and correct.
The // tag::single-source[] comment is now immediately after the :description: field, matching the standardized placement across documentation.

modules/develop/pages/kafka-clients.adoc (1)

6-6: Metadata marker relocation is consistent and correct.
The // tag::single-source[] comment has been moved to follow the :description: field, aligning with the PR’s single-sourcing standard.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	9901c46
🔍 Latest deploy log	https://app.netlify.com/sites/redpanda-docs-preview/deploys/681ab6d06296d40008e7fcc4
😎 Deploy Preview	https://deploy-preview-1114--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 site configuration.

[micheleRP]

@mikebroberg, @larsenpanda: This PR just updates (for consistency) metadata attributes between the docs and cloud-docs repos. It looks like you get automatically added as a reviewer for the partnership page, and I can't remove you. But there's no change to that content here, so no need to review!