Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a tool for converting Console v2 configs to v3 #1016

Merged
merged 9 commits into from
Mar 21, 2025
Merged

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Mar 18, 2025

Part of https://redpandadata.atlassian.net/browse/DOC-1025
Review deadline: March 21

This pull request includes several changes to the modules/upgrade/pages/migrate/console-v3.adoc file to improve the migration guide for Redpanda Console v3.0.0. The most important changes include the addition of new page attributes, a new section for the Redpanda Console migration tool, and updates to existing content for clarity and completeness.

Note to reviewers: The functionality of the tool has already been reviewed and approved in redpanda-data/docs-ui#269

Preview: https://deploy-preview-1016--redpanda-docs-preview.netlify.app/25.1/upgrade/migrate/console-v3/#migrator

Key changes:

New features:

  • Added page attributes :page-console-config-migrator: and :page-role: to enable the Wasm module required for the migrator tool.

Content updates:

  • Updated the reference for breaking changes to include a new document link.
  • Added a tip caption to suggest using the Redpanda Console migration tool for converting v2 configurations to v3 format.

New section:

  • Introduced a new section detailing the Redpanda Console migration tool, including a disclaimer and instructions on how to use the tool to migrate configurations.

Page previews

https://deploy-preview-1016--redpanda-docs-preview.netlify.app/25.1/upgrade/migrate/console-v3/#redpanda-console-migration-tool

Checks

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

Copy link

netlify bot commented Mar 18, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 4402123
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67dbf7c873f6e10008681125
😎 Deploy Preview https://deploy-preview-1016--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 site configuration.

@redpanda-data redpanda-data deleted a comment from hyperlint-ai bot Mar 18, 2025
@JakeSCahill JakeSCahill marked this pull request as ready for review March 19, 2025 10:18
@JakeSCahill JakeSCahill requested a review from a team as a code owner March 19, 2025 10:18
@redpanda-data redpanda-data deleted a comment from hyperlint-ai bot Mar 19, 2025
@redpanda-data redpanda-data deleted a comment from hyperlint-ai bot Mar 19, 2025
@redpanda-data redpanda-data deleted a comment from hyperlint-ai bot Mar 20, 2025
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.

lgtm! Does it make sense to add a link to this migration doc from the main Console docs?

@JakeSCahill
Copy link
Contributor Author

lgtm! Does it make sense to add a link to this migration doc from the main Console docs?

We’ve typically only linked to migration docs from the what’s new page because that’s where we expect users to learn about the need for migrations.

@JakeSCahill JakeSCahill merged commit d4ca48b into beta Mar 21, 2025
9 checks passed
@JakeSCahill JakeSCahill deleted the console-migrator branch March 21, 2025 15:22
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