Skip to content

Develop Data Transforms: Ensure learning objective attributes inside single source tag#1606

Merged
kbatuigas merged 1 commit intomainfrom
DOC-2047-add-learning-objectives-to-develop-data-transforms
Mar 12, 2026
Merged

Develop Data Transforms: Ensure learning objective attributes inside single source tag#1606
kbatuigas merged 1 commit intomainfrom
DOC-2047-add-learning-objectives-to-develop-data-transforms

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented Mar 12, 2026

Description

We recently updated the Develop Data Transforms doc and included new :learning-objective: attributes, but these currently do not render on the Cloud version of the doc because the new attributes are not inside the single source tags. This PR moves the tag above the attributes and ensures that they display correctly on both versions of the doc.

Resolves https://redpandadata.atlassian.net/browse/
Review deadline:

Page previews

Cloud: Develop Data Transforms
SM: Develop Data Transforms

Checks

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

@kbatuigas kbatuigas requested a review from a team as a code owner March 12, 2026 22:29
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 12, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 150d49d
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69b33e50b6e4f7000829553e
😎 Deploy Preview https://deploy-preview-1606--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 Mar 12, 2026

📝 Walkthrough

Walkthrough

A documentation file (modules/develop/pages/data-transforms/build.adoc) was updated with minor formatting changes. A learning-objective tag marker was added at the beginning of the file, and a brace character in a schema subject example was escaped to prevent AsciiDoc interpretation. These are localized, non-functional edits affecting only documentation rendering.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: moving learning objective attributes inside single source tags for proper rendering on both doc versions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description includes all required sections with relevant details about the changes, issue resolution, page previews, and type classification.

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

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-2047-add-learning-objectives-to-develop-data-transforms
📝 Coding Plan
  • Generate coding plan for human review comments

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

Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm!

@kbatuigas kbatuigas merged commit fe8a357 into main Mar 12, 2026
7 checks passed
@kbatuigas kbatuigas deleted the DOC-2047-add-learning-objectives-to-develop-data-transforms branch March 12, 2026 22:48
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.

2 participants