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

Upgrade rewrites for v24.3 #19098

Merged
merged 41 commits into from
Nov 18, 2024
Merged

Upgrade rewrites for v24.3 #19098

merged 41 commits into from
Nov 18, 2024

Conversation

mdlinville
Copy link
Contributor

@mdlinville mdlinville commented Nov 5, 2024

Upgrade rewrites for v24.3

  • [DOC-11170] Document version skipping
  • [DOC-8495] Incorrect details about alpha releases
  • [DOC-8412] Add details about monitoring upgrade progress
  • [DOC-11046] Discuss major and minor version upgrades separately
  • [DOC-11650] v24.3 upgrade instructions
  • Modularize Cloud and CRDB upgrade pages to use includes
  • Reduce version-specific details in upgrade pages
  • Update Kubernetes upgrade docs, reuse as much from self-hosted as possible, except do not update them to use the new setting because it doesn't work for the Operator
  • Update Cluster Virtualization content about upgrades to document support for version skipping

Previews

Cloud: src/current/cockroachcloud/upgrade-cockroach-version.md
Self-hosted: src/current/v24.3/upgrade-cockroach-version.md
Self-hosted Kubernetes: src/current/v24.3/upgrade-cockroachdb-kubernetes.md
src/current/v24.3/cluster-virtualization-overview.md
src/current/v24.3/work-with-virtual-clusters.md

Copy link

github-actions bot commented Nov 5, 2024

Files changed:

Copy link

netlify bot commented Nov 5, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 2fc3ce1
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/673b573a1260590008cf6f90

Copy link

netlify bot commented Nov 5, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 2fc3ce1
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/673b573ae404c90008053446

@mdlinville mdlinville requested review from dcrosta and dt November 5, 2024 22:01
@mdlinville
Copy link
Contributor Author

@dcrosta Please review the Cloud upgrade page (or nominate another reviewer)
@dt Please review the Self-Hosted upgrade page (or nominate another reviewer)

The bulk of this PR is modularizing the content into includes to build up both the self-hsoted and Cloud pages. It may be simpler to rely on the HTML previews to do the reviews.

Copy link

netlify bot commented Nov 5, 2024

Netlify Preview

Name Link
🔨 Latest commit 2fc3ce1
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/673b57393176700008c1baf2
😎 Deploy Preview https://deploy-preview-19098--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.

@mdlinville mdlinville force-pushed the DOC-11170 branch 5 times, most recently from b054284 to ead89d8 Compare November 6, 2024 00:39
Copy link

@dcrosta dcrosta left a comment

Choose a reason for hiding this comment

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

A couple of nits & suggestions, but overall lgtm!

src/current/_includes/common/upgrade/finalize-cloud.md Outdated Show resolved Hide resolved
src/current/_includes/common/upgrade/rollback-cloud.md Outdated Show resolved Hide resolved
src/current/_includes/common/upgrade/rollback-cloud.md Outdated Show resolved Hide resolved
src/current/_includes/common/upgrade/rollback-cloud.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/upgrade-cockroach-version.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/upgrade-cockroach-version.md Outdated Show resolved Hide resolved
- [DOC-11170] Document version skipping
- [DOC-8495] Incorrect details about alpha releases
- [DOC-8412] Add details about monitoring upgrade progress
- [DOC-11046] Discuss major and minor version upgrades separately
- [DOC-11650] v24.3 upgrade instructions
- Modularize Cloud and CRDB upgrade pages to use includes
- Reduce version-specific details in upgrade pages
@mdlinville mdlinville force-pushed the DOC-11170 branch 6 times, most recently from 777ead5 to 4802228 Compare November 7, 2024 00:21
@mdlinville mdlinville requested a review from dcrosta November 7, 2024 00:41
Copy link
Contributor

@mikeCRL mikeCRL left a comment

Choose a reason for hiding this comment

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

@mdlinville Reviewed the CC upgrade-cockroach-version. More later tonight for your review in the morning, if possible?

src/current/_includes/common/upgrade/overview.md Outdated Show resolved Hide resolved
src/current/_includes/common/upgrade/overview.md Outdated Show resolved Hide resolved
src/current/_includes/common/upgrade/overview.md Outdated Show resolved Hide resolved
src/current/_includes/common/upgrade/finalize-cloud.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/upgrade-cockroach-version.md Outdated Show resolved Hide resolved
@mdlinville mdlinville requested a review from mikeCRL November 15, 2024 19:14
@mdlinville
Copy link
Contributor Author

@mikeCRL Thank you for the reviews! Hopefully this won't take much additional work to get it merged for the release.

@shannonbradshaw
Copy link
Contributor

@mikeCRL I think you are the one reviewer who has requested more time to review. Based on the conversation, it looks like we have reviews from Dan, David, and Alicia. I'd like to get this merged. What do you still need to do here?

@mikeCRL mikeCRL enabled auto-merge (squash) November 18, 2024 15:05
@mikeCRL mikeCRL merged commit 159884e into main Nov 18, 2024
7 checks passed
@mikeCRL mikeCRL deleted the DOC-11170 branch November 18, 2024 15:12
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.

9 participants