Skip to content

Conversation

@ebembi-crdb
Copy link
Contributor

Summary

Complete 3-step cross-version archival process removing support for v22.2, v22.1, v21.2, v21.1, v20.2, and v2.1 documentation versions. This
follows the established pattern of archiving unsupported versions while preserving access through minimal infrastructure.

Changes Made

🗂️ Asset Cleanup

  • Delete 1,769 archived version image assets from images/v2.1/, images/v20.2/, images/v21.1/, images/v21.2/, images/v22.1/,
    images/v22.2/
  • Reduces repository size and eliminates unused assets

🔗 Cross-Version Link Fixes

  • Fix 40+ cross-version references to point to supported versions or archived documentation
  • Update backward-incompatible files (9 files): Convert v22.2 Jekyll links to v23.2 relative paths
  • Fix show-ranges deprecation notices: Replace v22.2 links with archived documentation references
  • Fix release notes and Kubernetes upgrade references across all supported versions

🛠️ Infrastructure Improvements

  • Add Jekyll SSL certificate bypass for Ruby 3.4.3 + macOS compatibility (openssl_fix.rb)
  • Update Gemfile with Ruby 3.x compatibility gems (csv, logger, base64, bigdecimal, mutex_m)
  • Fix Liquid syntax errors in image paths caused by global replacements

📋 Link Verification

  • All corrected links verified to exist and function properly
  • Cross-version references now cleanly separated (v23.1+ supported)
  • Backward-incompatible links consistently point to v23.2 (earliest supported version)

Archival Strategy

This implementation follows the established 3-step archival process:

  1. Remove cross-version links - All references to archived versions updated
  2. Delete archived assets - 1,769 image files removed from archived versions
  3. Use minimal infrastructure - Leverages existing stub pages (releases/v*.md) that redirect to archived documentation

Files Changed

  • 24 documentation files with cross-version link fixes
  • 1,769 image assets deleted from archived versions
  • 9 backward-incompatible files updated across all supported versions (v23.1-v25.4)

Complete 3-step cross-version archival process removing support for
v22.2, v22.1, v21.2, v21.1, v20.2, and v2.1 documentation versions.

**Major Changes:**
- Delete 1,769 archived version image assets
- Fix 40+ cross-version references to point to supported versions
- Update backward-incompatible links to use v23.2 (earliest supported)
- Fix Jekyll SSL certificate verification for Ruby 3.4.3 + macOS
- Add required Ruby 3.x gem dependencies

**Cross-Version Link Fixes:**
- Fix backward-incompatible files (9 files): v22.2 Jekyll links → v23.2 relative paths
- Fix show-ranges deprecation notices: v22.2 links → archived documentation
- Fix release notes and Kubernetes upgrade references
- Fix replication zone mapping references across all supported versions

**Infrastructure:**
- Preserve existing minimal infrastructure (releases/v*.md stub pages)
- Add openssl_fix.rb for Jekyll SSL bypass
- Update Gemfile with Ruby 3.x compatibility gems
- Fix Liquid syntax errors in image paths

**Verification:**
- All corrected links verified to exist and function
- Cross-version references now cleanly separated (v23.1+ supported)
- Jekyll server compatibility restored
@ebembi-crdb ebembi-crdb requested a review from a team as a code owner October 27, 2025 11:33
@github-actions
Copy link

Files changed:

  • src/current/Gemfile
  • src/current/_includes/releases/v23.1/v23.1.3.md:
  • src/current/_includes/v23.1/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v23.1 file or include
  • src/current/_includes/v23.1/orchestration/kubernetes-upgrade-cluster-helm.md:
  • src/current/_includes/v23.1/orchestration/kubernetes-upgrade-cluster-manual.md:
  • src/current/_includes/v23.1/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v23.1/sql/show-ranges-output-deprecation-notice.md:
  • src/current/_includes/v23.2/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v23.2 file or include
  • src/current/_includes/v23.2/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v23.2/sql/show-ranges-output-deprecation-notice.md:
  • src/current/_includes/v24.1/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v24.1 file or include
  • src/current/_includes/v24.1/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v24.2/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v24.2 file or include
  • src/current/_includes/v24.2/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v24.3/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v24.3 file or include
  • src/current/_includes/v24.3/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v25.1/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v25.1 file or include
  • src/current/_includes/v25.1/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v25.2/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v25.2 file or include
  • src/current/_includes/v25.2/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v25.3/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v25.3 file or include
  • src/current/_includes/v25.3/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/_includes/v25.4/backward-incompatible/alpha.1.md:
    • Warning: include not used in any v25.4 file or include
  • src/current/_includes/v25.4/sql/replication-zone-patterns-to-multiregion-sql-mapping.md:
  • src/current/comprehensive-cross-version-archive-plan.md
  • src/current/cross-version-links-analysis-report.md
  • src/current/cross_version_assets_report.csv
  • src/current/fix_all_cross_version_issues.sh
  • src/current/fix_image_syntax.sh
  • src/current/images/v2.1/2automated-scaling-repair.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/2distributed-transactions.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/2go-implementation.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/2open-source.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/2simplified-deployments.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/2strong-consistency.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/CockroachDB_Training_Wide.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/Parallel_Statement_Execution_Error_Mismatch.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/Parallel_Statement_Hybrid_Execution.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/Parallel_Statement_Normal_Execution.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/Sequential_Statement_Execution.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-cluster-overview-panel.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-custom-chart-debug-00.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-custom-chart-debug-01.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-components.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-list.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-map-after-license.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-map-before-license.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-map-complete.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-map-navigation.gif:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-node-map.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-region-component.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-single-node.gif:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-statements-page.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin-ui-time-range.gif:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_available_disk_capacity.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_capacity.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_cpu_percent.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_cpu_time.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_database_grants_view.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_database_tables_view.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_iops.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_read_bytes.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_read_ops.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_read_time.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_write_bytes.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_write_ops.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_disk_write_time.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_events.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_file_descriptors.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_hovering.gif:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_jobs_page.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_jobs_page_new.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_memory_usage.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_memory_usage_new.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_network_bytes_received.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_network_bytes_sent.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_node_count.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_nodes_page.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_overview_dashboard.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_ranges.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replica_quiescence.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replica_snapshots.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replicas_migration.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replicas_migration2.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replicas_migration3.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replicas_per_node.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_replicas_per_store.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_service_latency_99_percentile.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_sql_byte_traffic.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_sql_connections.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_sql_queries.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_sql_query_errors.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_statements_details_page.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_summary_panel.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/admin_ui_transactions.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/after-decommission1.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/after-decommission2.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/automated-operations1.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/before-decommission1.png:
    • Warning: include not used in any v25.4 file or include
  • src/current/images/v2.1/before-decommission2.png:
    • Warning: include not used in any v25.4 file or include

@netlify
Copy link

netlify bot commented Oct 27, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 9c75ef1
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/68ff588ffdfc53000889cd3a

@netlify
Copy link

netlify bot commented Oct 27, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 9c75ef1
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/68ff588f518eb400089955ad

@netlify
Copy link

netlify bot commented Oct 27, 2025

Deploy Preview for cockroachdb-docs failed. Why did it fail? →

Name Link
🔨 Latest commit 9c75ef1
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/68ff588ff9f2cc00085f7944

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.

I can't review this in more detail until the build is working. I spotted a couple of obvious issues that I left comments about.

Please consider breaking this into several smaller PRs. It's going to be difficult for me to meaningfully review a PR with this many changed files in it and trust that what we're merging won't have unintended consequences even if the build tests do pass.

gem "rss"
gem "webrick"
gem "jekyll-minifier"
gem 'csv'
Copy link
Contributor

Choose a reason for hiding this comment

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

please let's not do rubygems tweaks in this docs PR

@@ -0,0 +1,294 @@
# Cross-Version Links Analysis Report
Copy link
Contributor

Choose a reason for hiding this comment

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

please don't add LLM-generated plan files to the docs repo

@@ -0,0 +1,41 @@
#!/bin/bash
Copy link
Contributor

Choose a reason for hiding this comment

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

i don't think this is a good home for this script, it looks like a one-off LLM script

@@ -0,0 +1,14 @@
#!/bin/bash
Copy link
Contributor

Choose a reason for hiding this comment

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

i don't think this is a good home for this script, this looks like a one-off LLM fixup script

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