Add offline archive creation script #22442
Open
+894
−0
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
Adds tools for creating a complete offline archive of the CockroachDB documentation that can be viewed locally in a browser. - create_full_archive.py: Main script that builds the offline archive - OFFLINE_ARCHIVE_README.md: Usage documentation Features: - Supports all doc versions (v23.1 - v26.1) - Localizes Google Fonts and jQuery for offline use - Fixes paths for relative navigation - Preserves version switcher functionality - Hides online-only elements (search, AI widgets) - Creates distributable ZIP archive
❌ Deploy Preview for cockroachdb-interactivetutorials-docs failed. Why did it fail? →
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Few changes -
- Stop mass HTML/JS surgery with blind regex - create_full_archive.py and other helpers perform many global re.sub() edits on HTML (e.g., mass href/src rewrites and head/body injections). Regex on HTML/JS is fragile and can corrupt inline scripts or JSON
- Make external downloads robust and/or vendor critical assets - the scripts download Google Fonts and navigation assets with single requests.get() calls. If the network or remote host is flaky, the archive build fails.flaky external calls make CI and local runs unreliable.Maybe add a requests.Session() with retries/backoff
- Make symlink handling portable — copy resolved targets instead of recreating symlinks - copy_tree_ignore_broken_symlinks() may recreate symlinks. Zipping symlinks and cross-platform behavior (Windows) is error-prone.
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
create_full_archive.pyscript for creating complete offline archives of the documentationOFFLINE_ARCHIVE_README.mdwith usage documentationFeatures
Usage
Test plan
python3 create_full_archive.pyafter building the sitecomplete_archive/index.htmlin browser