Skip to content

DOC-17061: Replace remote_include with vendored includes#23297

Open
ebembi-crdb wants to merge 1 commit into
mainfrom
replace-remote-includes
Open

DOC-17061: Replace remote_include with vendored includes#23297
ebembi-crdb wants to merge 1 commit into
mainfrom
replace-remote-includes

Conversation

@ebembi-crdb
Copy link
Copy Markdown
Contributor

Summary

  • Vendors 88 machine-generated doc files from cockroachdb/cockroach into _includes/cockroach-generated/
  • Updates 55 versioned pages to use local {% include %} instead of {% remote_include %} directives
  • Eliminates runtime dependencies on raw.githubusercontent.com for generated reference docs (cluster settings, event log, functions and operators, log formats, logging)

This is PR 7 of 10 splitting #23256 into reviewable chunks.

Jira: DOC-17061

Test plan

  • Verify {% include cockroach-generated/... %} renders the same content as the old {% remote_include %} calls
  • Run local Jekyll build and check cluster-settings, eventlog, functions-and-operators, log-formats, and logging pages across all versions
  • Confirm no remaining remote_include references to cockroachdb/cockroach

🤖 Generated with Claude Code

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>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 148f916
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/6a032a6c24a7af000815101e

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 148f916
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/6a032a6c567caf0008daa66a

@github-actions
Copy link
Copy Markdown

Files changed:

  • src/current/_includes/cockroach-generated/release-23.1/eventlog.md
  • src/current/_includes/cockroach-generated/release-23.1/logformats.md
  • src/current/_includes/cockroach-generated/release-23.1/logging.md
  • src/current/_includes/cockroach-generated/release-23.1/settings/settings.html
  • src/current/_includes/cockroach-generated/release-23.1/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-23.1/sql/functions.md
  • src/current/_includes/cockroach-generated/release-23.1/sql/operators.md
  • src/current/_includes/cockroach-generated/release-23.1/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-23.2/eventlog.md
  • src/current/_includes/cockroach-generated/release-23.2/logformats.md
  • src/current/_includes/cockroach-generated/release-23.2/logging.md
  • src/current/_includes/cockroach-generated/release-23.2/settings/settings.html
  • src/current/_includes/cockroach-generated/release-23.2/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-23.2/sql/functions.md
  • src/current/_includes/cockroach-generated/release-23.2/sql/operators.md
  • src/current/_includes/cockroach-generated/release-23.2/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-24.1/eventlog.md
  • src/current/_includes/cockroach-generated/release-24.1/logformats.md
  • src/current/_includes/cockroach-generated/release-24.1/logging.md
  • src/current/_includes/cockroach-generated/release-24.1/settings/settings.html
  • src/current/_includes/cockroach-generated/release-24.1/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-24.1/sql/functions.md
  • src/current/_includes/cockroach-generated/release-24.1/sql/operators.md
  • src/current/_includes/cockroach-generated/release-24.1/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-24.2/eventlog.md
  • src/current/_includes/cockroach-generated/release-24.2/logformats.md
  • src/current/_includes/cockroach-generated/release-24.2/logging.md
  • src/current/_includes/cockroach-generated/release-24.2/settings/settings.html
  • src/current/_includes/cockroach-generated/release-24.2/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-24.2/sql/functions.md
  • src/current/_includes/cockroach-generated/release-24.2/sql/operators.md
  • src/current/_includes/cockroach-generated/release-24.2/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-24.3/eventlog.md
  • src/current/_includes/cockroach-generated/release-24.3/logformats.md
  • src/current/_includes/cockroach-generated/release-24.3/logging.md
  • src/current/_includes/cockroach-generated/release-24.3/settings/settings.html
  • src/current/_includes/cockroach-generated/release-24.3/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-24.3/sql/functions.md
  • src/current/_includes/cockroach-generated/release-24.3/sql/operators.md
  • src/current/_includes/cockroach-generated/release-24.3/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-25.1/eventlog.md
  • src/current/_includes/cockroach-generated/release-25.1/logformats.md
  • src/current/_includes/cockroach-generated/release-25.1/logging.md
  • src/current/_includes/cockroach-generated/release-25.1/settings/settings.html
  • src/current/_includes/cockroach-generated/release-25.1/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-25.1/sql/functions.md
  • src/current/_includes/cockroach-generated/release-25.1/sql/operators.md
  • src/current/_includes/cockroach-generated/release-25.1/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-25.2/eventlog.md
  • src/current/_includes/cockroach-generated/release-25.2/logformats.md
  • src/current/_includes/cockroach-generated/release-25.2/logging.md
  • src/current/_includes/cockroach-generated/release-25.2/settings/settings.html
  • src/current/_includes/cockroach-generated/release-25.2/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-25.2/sql/functions.md
  • src/current/_includes/cockroach-generated/release-25.2/sql/operators.md
  • src/current/_includes/cockroach-generated/release-25.2/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-25.3/eventlog.md
  • src/current/_includes/cockroach-generated/release-25.3/logformats.md
  • src/current/_includes/cockroach-generated/release-25.3/logging.md
  • src/current/_includes/cockroach-generated/release-25.3/settings/settings.html
  • src/current/_includes/cockroach-generated/release-25.3/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-25.3/sql/functions.md
  • src/current/_includes/cockroach-generated/release-25.3/sql/operators.md
  • src/current/_includes/cockroach-generated/release-25.3/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-25.4/eventlog.md
  • src/current/_includes/cockroach-generated/release-25.4/logformats.md
  • src/current/_includes/cockroach-generated/release-25.4/logging.md
  • src/current/_includes/cockroach-generated/release-25.4/settings/settings.html
  • src/current/_includes/cockroach-generated/release-25.4/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-25.4/sql/functions.md
  • src/current/_includes/cockroach-generated/release-25.4/sql/operators.md
  • src/current/_includes/cockroach-generated/release-25.4/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-26.1/eventlog.md
  • src/current/_includes/cockroach-generated/release-26.1/logformats.md
  • src/current/_includes/cockroach-generated/release-26.1/logging.md
  • src/current/_includes/cockroach-generated/release-26.1/settings/settings.html
  • src/current/_includes/cockroach-generated/release-26.1/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-26.1/sql/functions.md
  • src/current/_includes/cockroach-generated/release-26.1/sql/operators.md
  • src/current/_includes/cockroach-generated/release-26.1/sql/window_functions.md
  • src/current/_includes/cockroach-generated/release-26.2/eventlog.md
  • src/current/_includes/cockroach-generated/release-26.2/logformats.md
  • src/current/_includes/cockroach-generated/release-26.2/logging.md
  • src/current/_includes/cockroach-generated/release-26.2/settings/settings.html
  • src/current/_includes/cockroach-generated/release-26.2/sql/aggregates.md
  • src/current/_includes/cockroach-generated/release-26.2/sql/functions.md
  • src/current/_includes/cockroach-generated/release-26.2/sql/operators.md
  • src/current/_includes/cockroach-generated/release-26.2/sql/window_functions.md
  • src/current/v23.1/cluster-settings.md
  • src/current/v23.1/eventlog.md
  • src/current/v23.1/functions-and-operators.md
  • src/current/v23.1/log-formats.md
  • src/current/v23.1/logging.md
  • src/current/v23.2/cluster-settings.md
  • src/current/v23.2/eventlog.md
  • src/current/v23.2/functions-and-operators.md
  • src/current/v23.2/log-formats.md
  • src/current/v23.2/logging.md
  • src/current/v24.1/cluster-settings.md
  • src/current/v24.1/eventlog.md

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Netlify Preview

Name Link
🔨 Latest commit 148f916
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/6a032a6ca4941b0008d03406
😎 Deploy Preview https://deploy-preview-23297--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 project configuration.

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.

1 participant