DOC-17061: Replace remote_include with vendored includes#23297
Open
ebembi-crdb wants to merge 2 commits into
Open
DOC-17061: Replace remote_include with vendored includes#23297ebembi-crdb wants to merge 2 commits into
ebembi-crdb wants to merge 2 commits into
Conversation
Vendor 88 machine-generated doc files from cockroachdb/cockroach into
_includes/cockroach-generated/ and update 55 versioned pages to use
local {% include %} instead of {% remote_include %} directives.
This eliminates runtime dependencies on raw.githubusercontent.com for
generated reference docs (cluster settings, event log, functions and
operators, log formats, logging).
Part of DOC-17061.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
Files changed:
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
4 tasks
rmloveland
requested changes
May 19, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
@ebembi-crdb thank you for putting this together! wanted to drop some high level comments based on a quick glance with codex in a local worktree before the Docs Weekly meeting tomorrow where we will discuss this work further:
- this does not remove all
remote_includetags, it leaves a bunch in e.g._includes/v26.2/misc/tooling.md(to see the remaining uses ofremote_includerunrg -n 'remote_include https://raw\.githubusercontent\.com/cockroachdb/cockroach' src/current) - this appears to be a one-time copying of files, but there is no tooling added to automate this process. any PR we merge needs to at least reference how we plan to use scripts/tools to automate this process, even if those tools actually live elsewhere (eg in CI/GH actions, and not the docs repo itself)
obv these can be fixed! just adding here for visibility / discussion for meeting tomorrow
Resolve review feedback by replacing all remaining remote_include references to cockroachdb/cockroach in tooling.md files (v20.2–v26.2) and latest_operator_version.md with vendored values. Add vendor_cockroach_docs.sh to automate syncing generated docs and driver/ORM version strings from the cockroach repo. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
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
_includes/cockroach-generated/{% include %}instead of{% remote_include %}directivesThis is PR 7 of 10 splitting #23256 into reviewable chunks.
Jira: DOC-17061
Test plan
{% include cockroach-generated/... %}renders the same content as the old{% remote_include %}callsremote_includereferences to cockroachdb/cockroach🤖 Generated with Claude Code