-
Notifications
You must be signed in to change notification settings - Fork 1
Refactoring: Significant portions migrated to cratedb-guide
#270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughLarge-scale deletion of documentation: removed most files under docs/connect and docs/integrate, deleted docs/status.md, and simplified docs/index.md navigation. No code, API, or exported-entity changes—only documentation content removals and one link update in docs/legacy.rst. Changes
Sequence Diagram(s)(omitted — changes are documentation deletions and a link update; no control-flow or feature changes to represent) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~15 minutes Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these settings in your CodeRabbit configuration. 📒 Files selected for processing (18)
💤 Files with no reviewable changes (16)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (17)
docs/connect/cli.md(0 hunks)docs/connect/df.md(0 hunks)docs/connect/index.md(0 hunks)docs/connect/java.rst(0 hunks)docs/connect/javascript.rst(0 hunks)docs/connect/orm.md(0 hunks)docs/connect/php.rst(0 hunks)docs/connect/python.rst(0 hunks)docs/connect/ruby.rst(0 hunks)docs/index.md(1 hunks)docs/integrate/bi.md(0 hunks)docs/integrate/etl.md(0 hunks)docs/integrate/framework.md(0 hunks)docs/integrate/metrics.md(0 hunks)docs/integrate/ml.md(0 hunks)docs/integrate/visualize.md(0 hunks)docs/status.md(0 hunks)
💤 Files with no reviewable changes (16)
- docs/connect/java.rst
- docs/connect/javascript.rst
- docs/connect/php.rst
- docs/integrate/etl.md
- docs/integrate/bi.md
- docs/integrate/ml.md
- docs/connect/cli.md
- docs/connect/ruby.rst
- docs/status.md
- docs/integrate/visualize.md
- docs/integrate/metrics.md
- docs/connect/df.md
- docs/connect/python.rst
- docs/connect/orm.md
- docs/connect/index.md
- docs/integrate/framework.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Summary
🔇 Additional comments (1)
docs/index.md (1)
174-177: Fix unresolved cross-reference to build status (docs/index.md:176)The page uses {ref}
build status <build-status>but I could not find a local (build-status)= label. docs/conf.py does not declare an intersphinx_mapping in this repo (it imports crate.theme.rtd.conf.crate_clients_tools which may supply mappings). The repo also uses the "guide" key elsewhere (docs/index.md:38 ::link: guide:ide), so the correct fix depends on whether that external mapping exists.Files to check:
- docs/index.md (line ~176) — update the ref or add a local label.
- docs/conf.py (docs/conf.py) — verify whether the imported theme/package provides an intersphinx mapping named "guide".
Suggested change (if the "guide" intersphinx mapping is available):
- Looking for the status of integration tests? See the {ref}`build status <build-status>` page. + Looking for the status of integration tests? See the {ref}`build status <guide:build-status>` page.If "guide" is not provided by the imported configuration, either reintroduce a local (build-status)= label on the target page or replace the reference with a plain external URL.
About
On recent content refactorings, a few portions have been moved.
References
crate-clients-tools, to be retired soon cratedb-guide#221crate-clients-tools, to be retired soon cratedb-guide#222/cc @karynzv, @hammerhead, @surister