Add scripts and docs for creating offline documentation archives #22441
Conversation
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
…ives This adds a complete toolkit for creating portable, offline documentation archives for any CockroachDB version: Scripts: - create_single_archive.py: Main entry point for single version archives - create_all_archives_fixed.py: Batch creation for multiple versions - snapshot_relative.py: Core archiver that creates base structure - make_navigation_dynamic_v2.py: Makes navigation work with any folder name - fix_*.py: Supporting scripts for the 14-step archive process Documentation: - README_ARCHIVE_CREATION.md: Comprehensive guide with troubleshooting - CREATE_PORTABLE_ARCHIVE.md: Quick start guide Features: - Creates self-contained offline archives (~100-200MB per version) - Dynamic navigation that works when archive is renamed - Localized Google Fonts for offline use - Single version sidebar (no newer version references) - Relative paths for complete portability Usage: cd src/current python3 create_single_archive.py v23.1
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
Files changed:
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Few changes that we'll need -
|
mohini-crl
requested changes
Feb 9, 2026
Contributor
mohini-crl
left a comment
mohini-crl
left a comment
There was a problem hiding this comment.
Please read the comment to check the review changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Scripts Added
create_single_archive.pycreate_all_archives_fixed.pysnapshot_relative.pymake_navigation_dynamic_v2.pyfix_*.pyDocumentation Added
README_ARCHIVE_CREATION.md- Comprehensive guide with troubleshootingCREATE_PORTABLE_ARCHIVE.md- Quick start guideUsage
Test plan
create_single_archive.py v22.2successfully