Skip to content

Vendor cockroach repo assets and remove external GitHub dependencies#23256

Open
ebembi-crdb wants to merge 1 commit into
mainfrom
vendor-cockroach-docs-assets
Open

Vendor cockroach repo assets and remove external GitHub dependencies#23256
ebembi-crdb wants to merge 1 commit into
mainfrom
vendor-cockroach-docs-assets

Conversation

@ebembi-crdb
Copy link
Copy Markdown
Contributor

Summary

  • Vendors static files (K8s manifests, Prometheus/Grafana configs, monitoring rules) into src/current/files/cockroach/ so docs serve downloadable assets directly instead of linking to GitHub
  • Vendors generated doc files (eventlog, logging, cluster settings, functions/operators) into src/current/_includes/cockroach-generated/ across 11 release branches, replacing remote_include build-time fetches with local Jekyll include tags
  • Replaces remote_include version-string extractions in tooling.md with hardcoded values from the Go source files
  • Converts ~8,800 GitHub hyperlinks (PRs, issues, commits, blob/tree views, releases) to plain-text references
  • Updates all raw.githubusercontent.com download URLs to cockroachlabs.com/docs/files/cockroach/ paths

Test plan

  • Verify grep -rn 'raw.githubusercontent.com/cockroachdb/cockroach' src/ returns zero matches
  • Verify grep -rn 'remote_include.*cockroachdb/cockroach' src/ returns zero matches
  • Run a local Jekyll build and confirm:
    • Static files present in _site/docs/files/cockroach/
    • Cluster settings, eventlog, logging, functions-and-operators pages render correctly
    • Tooling pages show correct driver version numbers
    • Release notes render without broken markdown (no orphaned [#NNN] brackets)
  • Spot-check a sample curl command from the docs against localhost

🤖 Generated with Claude Code

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 112d0fa
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69fb0bc605a2ed0007f6bf6d

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Deploy Preview for cockroachdb-api-docs ready!

Name Link
🔨 Latest commit 112d0fa
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69fb0bc6a6562300086425e3
😎 Deploy Preview https://deploy-preview-23256--cockroachdb-api-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.

@ebembi-crdb ebembi-crdb force-pushed the vendor-cockroach-docs-assets branch from 2d9a028 to daf0546 Compare May 6, 2026 09:33
Vendor static files (K8s manifests, Prometheus configs, Grafana
dashboards, monitoring rules) into src/current/files/cockroach/ and
generated docs into src/current/_includes/cockroach-generated/ so
the docs site builds and serves without fetching from the cockroachdb/cockroach
GitHub repo at build time or linking to it at read time.

- Vendor 32 static files previously fetched via curl/wget
- Vendor 88 generated doc files (8 files × 11 release branches)
- Replace remote_include tags with local Jekyll includes
- Replace remote_include version extractions with hardcoded values
- Replace raw.githubusercontent.com download URLs with cockroachlabs.com paths
- Unlink PR, issue, and commit reference-style and inline links
- Update blob/tree links to point to vendored copies or plain text
- Clean up release, repo, and comment references

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ebembi-crdb ebembi-crdb force-pushed the vendor-cockroach-docs-assets branch from daf0546 to 112d0fa Compare May 6, 2026 09:37
@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Netlify Preview

Name Link
🔨 Latest commit 2d9a028
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69fb09c95e05380008e4bacc
😎 Deploy Preview https://deploy-preview-23256--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.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Netlify Preview

Name Link
🔨 Latest commit 112d0fa
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69fb0bc658fe6f0008841566
😎 Deploy Preview https://deploy-preview-23256--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.

@ebembi-crdb
Copy link
Copy Markdown
Contributor Author

This PR has been split into 10 smaller PRs

To make review manageable, #23256 (1,648 files, 130K+ insertions) has been split into 10 PRs matching the Jira subtasks of DOC-17040:

PR Jira Title Files
#23301 DOC-17055 Remove cockroach PR/commit links from release notes 287
#23302 DOC-17056 Remove cockroach issue links from known limitations 542
#23306 DOC-17057 Remove inline cockroach issue/PR links from docs prose 292
#23303 DOC-17058 Remove cockroach links from advisories 68
#23304 DOC-17059 Remove/replace cockroach links in YAML/data files 10
#23305 DOC-17060 Remove cockroach source links from release/download pages 4
#23297 DOC-17061 Replace remote_include with vendored includes 143
#23298 DOC-17062 Replace raw cockroach file downloads 138
#23299 DOC-17063 Replace source file/directory links 111
#23300 DOC-17064 Replace issue filing/search links 54

All 10 PRs are independent and can be reviewed/merged in any order. This PR should be closed (without merging) after all sub-PRs are merged.

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