Skip to content

DOC-1443 remove tab for Cloud api to enable WASM#1156

Merged
micheleRP merged 2 commits intomainfrom
DOC-1443-remove-tab-for-Cloud-api-to-enable-WASM
Jun 9, 2025
Merged

DOC-1443 remove tab for Cloud api to enable WASM#1156
micheleRP merged 2 commits intomainfrom
DOC-1443-remove-tab-for-Cloud-api-to-enable-WASM

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Jun 9, 2025 •
edited
Loading

Description

This pull request simplifies the documentation for enabling data transforms in modules/develop/pages/data-transforms/build.adoc. The changes remove the Cloud API method and streamline instructions to focus solely on enabling the feature using the rpk command-line tool.

Documentation simplification:

  • Removed the Cloud API method for enabling data transforms, including detailed examples and API request instructions, to streamline the documentation. The focus is now solely on using the rpk command-line tool.
  • Updated the rpk instructions to include a cross-reference to the cluster property documentation (data_transforms_enabled) for clarity.
  • Simplified the note about rolling restarts, removing redundant explanations about operation IDs and long-running operations.

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

Page previews

Enable data transforms (in Cloud)

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner June 9, 2025 14:23
@netlify
Copy link

netlify bot commented Jun 9, 2025 •
edited
Loading

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 5e18a53
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6846ef2e9468b40008d3c326
😎 Deploy Preview https://deploy-preview-1156--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
Contributor

coderabbitai bot commented Jun 9, 2025 •
edited
Loading

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The documentation for enabling data transforms on cloud clusters was updated by removing the section that described how to enable this feature via the Cloud API. The instructions now exclusively recommend using the rpk command-line tool to set the data_transforms_enabled property to true. Details about authentication, API calls, and example usage of the Cloud API were eliminated. The note regarding the need for a rolling restart and the time required for changes to take effect was retained in a shortened form. No changes were made to code, configuration, or exported entities.

Assessment against linked issues

Objective Addressed Explanation
Remove tab for Cloud API to enable WASM (DOC-1443) ✅
Instruct users to enable Data Transforms via rpk only (DOC-1443) ✅

Possibly related PRs

  • DOC-1282 rpk cluster config for cloud wasm #1092: Adds and formats detailed instructions for both the rpk CLI and Cloud API methods for enabling data transforms, which is directly related as it covers the same documentation area, but with the opposite approach.

Suggested reviewers

  • alenkacz
  • mattschumpert
  • asimms41
  • simon0191

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

coderabbitai[bot]
coderabbitai bot reviewed Jun 9, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/develop/pages/data-transforms/build.adoc (1)

32-32: Correct grammatical typo in NOTE.

Change “This property require a rolling restart” to “This property requires a rolling restart” for subject-verb agreement.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ecbec8c and 06bd55b.

📒 Files selected for processing (1)
  • modules/develop/pages/data-transforms/build.adoc (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: run-tests (ubuntu-latest)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/develop/pages/data-transforms/build.adoc (1)

25-31: Approve rpk-centric enablement instructions.

The new instructions cleanly focus on using the rpk CLI to toggle data_transforms_enabled and include a helpful cross-reference to the cluster-properties page. This streamlines the process and eliminates previous Cloud API complexity.

@micheleRP micheleRP requested a review from rockwotj June 9, 2025 14:32
@kbatuigas
Copy link
Contributor

kbatuigas commented Jun 9, 2025

We also use data_transforms_enabled in the example to configure cluster properties https://deploy-preview-1156--redpanda-docs-preview.netlify.app/redpanda-cloud/manage/cluster-maintenance/config-cluster/#set-cluster-configuration-properties can we find a different property to replace data_transforms_enabled?

@micheleRP
Copy link
Contributor Author

micheleRP commented Jun 9, 2025 •
edited
Loading

We also use data_transforms_enabled in the example to configure cluster properties https://deploy-preview-1156--redpanda-docs-preview.netlify.app/redpanda-cloud/manage/cluster-maintenance/config-cluster/#set-cluster-configuration-properties can we find a different property to replace data_transforms_enabled?

Good idea: I'll use a different property there. I'll need to do that in a separate PR in the cloud_docs repo. @kbatuigas please see redpanda-data/cloud-docs#322

kbatuigas
kbatuigas approved these changes Jun 9, 2025
View reviewed changes
Copy link
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

Also approved redpanda-data/cloud-docs#322

@micheleRP micheleRP merged commit 0b8b251 into main Jun 9, 2025
7 checks passed
@micheleRP micheleRP deleted the DOC-1443-remove-tab-for-Cloud-api-to-enable-WASM branch June 9, 2025 18:43
JakeSCahill pushed a commit that referenced this pull request Jul 15, 2025
@micheleRP @JakeSCahill
DOC-1443 remove tab for Cloud api to enable WASM (#1156)
d0f8de4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@rockwotj rockwotj rockwotj approved these changes

@kbatuigas kbatuigas kbatuigas approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@micheleRP @kbatuigas @rockwotj