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

Update the restore backups across major version docs for innovation releases #19375

Merged
merged 2 commits into from
Feb 20, 2025

Conversation

kathancox
Copy link
Contributor

Fixes DOC-11980

This PR updates the Restoring Backups Across Versions page to account for innovation releases.

Innovation releases were introduced in v24.2, so the changes have been added to v24.1+ since the policy is that users can restore to the same major version, or one above — v24.1 clusters can upgrade to v24.3 (skipping the first v24.2 innovation release).

Copy link

netlify bot commented Feb 13, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 9f65113
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/67b74fafbd3be40008a260c0

Copy link

netlify bot commented Feb 13, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 9f65113
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/67b74fafb9ec0300077c21ba

@kathancox kathancox force-pushed the restore-policy-innovation branch from d6b8202 to 538fd2e Compare February 13, 2025 20:44
Copy link

netlify bot commented Feb 13, 2025

Netlify Preview

Name Link
🔨 Latest commit d6b8202
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67ae58a7a80fe0000881413c
😎 Deploy Preview https://deploy-preview-19375--cockroachdb-docs.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.

Copy link

netlify bot commented Feb 13, 2025

Netlify Preview

Name Link
🔨 Latest commit 9f65113
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67b74faf2aaee3000858f0c9
😎 Deploy Preview https://deploy-preview-19375--cockroachdb-docs.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.

@kathancox kathancox requested a review from msbutler February 13, 2025 20:55
@kathancox kathancox requested a review from rmloveland February 18, 2025 13:33
Copy link
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

LGTM! i was surprised that the v24.3 and v25.1 docs referred to a "v24.1.x format", but i assume that is referring to some internals of how backups work that is beyond my ken

@@ -11,23 +11,29 @@ This page describes the support Cockroach Labs provides for restoring backups ac
- [Support for long-term backup archival](#support-for-long-term-backup-archival)

{{site.data.alerts.callout_info}}
Since CockroachDB considers the cluster version when running a backup, this page refers to versions in a "v22.2.x" format. For example, both v22.2.8 and v22.2.14 are considered as v22.2 clusters for backup purposes.
Since CockroachDB considers the cluster version when running a backup, this page refers to versions in a "v24.1.x" format. For example, both v24.1.8 and v24.1.12 are considered as v24.1 clusters for backup purposes.
Copy link
Contributor

Choose a reason for hiding this comment

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

interesting, v25.1 docs still refer to a "v24.1.x" format? this has had technical review so must be correct, but as a general reader this stood out to me

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried out the liquid variable for page version with this format, and it works — so I've updated this first callout in each version's page with this so that it will automatically update. I haven't updated the table with this as it'll be hard to control as we progress in versions and the restore pattern is specific.

@kathancox kathancox force-pushed the restore-policy-innovation branch from 61fb57c to 06898a3 Compare February 20, 2025 15:43
@kathancox kathancox force-pushed the restore-policy-innovation branch from 06898a3 to 9f65113 Compare February 20, 2025 15:52
@kathancox kathancox merged commit 6de7469 into main Feb 20, 2025
6 checks passed
@kathancox kathancox deleted the restore-policy-innovation branch February 20, 2025 15:58
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.

3 participants