Replace migration guides with automated controller-based migration#23254
Draft
Replace migration guides with automated controller-based migration#23254
Conversation
Replace the existing manual migration guides with automated migration guides from helm-charts repository. The new guides document the automatic migration controller that handles the migration process with minimal manual intervention. Sources: - helm-charts/docs/migration/helm/controller_migration.md - helm-charts/docs/migration/operator/controller_migration.md Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
Apply CockroachDB documentation style guidelines to the migration
guides, including:
- Update introductions to match established documentation tone
- Add Preview callouts for CockroachDB Operator
- Change all step headings to imperative mood with proper casing
- Convert "Before You Begin" to "Before you begin" with proper formatting
- Add Jekyll callouts for important warnings and information
- Use Liquid variables for product names ({{ site.data.products.* }})
- Update terminology to match docs conventions (e.g., "Kubernetes" not "K8s")
- Format initial sections with proper Jekyll syntax
Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR replaces the existing manual migration guides with new automated migration guides that document the CockroachDB Operator's migration controller.
Changes
This PR contains two atomic commits:
Replace migration guides with controller-based migration content
v26.2/migrate-cockroachdb-kubernetes-helm.mdwith content fromhelm-charts/docs/migration/helm/controller_migration.mdv26.2/migrate-cockroachdb-kubernetes-operator.mdwith content fromhelm-charts/docs/migration/operator/controller_migration.mdApply documentation style guide to migration content
Migration Guide Updates
The new guides document the automatic migration controller that:
Testing