Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Aug 24, 2025

About

Include a few updates to probe here, for example the phasing-out of crate-clients-tools, and a mitigation against recently increased build errors on CI.

Preview

https://cratedb-guide--266.org.readthedocs.build/

References

Copy link

coderabbitai bot commented Aug 24, 2025

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 7 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7f7cb33 and 6e6124a.

📒 Files selected for processing (3)
  • docs/admin/create-user.md (1 hunks)
  • docs/home/index.md (0 hunks)
  • docs/use/migrate/rockset/index.md (0 hunks)

Walkthrough

Bump docs dependency and update documentation pages: crate-docs-theme version constraint in docs/requirements.txt updated; several documentation tiles and Ecosystem Catalog references removed from docs/home/index.md and docs/use/migrate/rockset/index.md; two Markdown links in docs/admin/create-user.md replaced with Sphinx {ref} cross-references.

Changes

Cohort / File(s) Summary
Docs dependency bump
docs/requirements.txt
Update crate-docs-theme version constraint from >=0.38.5 to >=0.40.0.dev0.
Create-user cross-references
docs/admin/create-user.md
Replace two Markdown/inv-style links in the CREATE USER section with Sphinx {ref} cross-references ({ref}install crash crate-crash:getting-startedand{ref}connect <connect>); adjust surrounding text.
Home page tiles updated / Ecosystem Catalog removed
docs/home/index.md
Remove the Ecosystem Catalog tile; change Integration Tutorials I icon from category to integration_instructions; replace Integration Tutorials II tile with a local_library tile and new descriptive text (remove previous external link and header).
Migrate doc cleanup
docs/use/migrate/rockset/index.md
Remove top-level Ecosystem Catalog navigation item and explicit link anchor; no replacements added.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

maintenance, refactoring

Suggested reviewers

  • hammerhead
  • bmunkholm
  • karynzv
  • surister

Poem

I twitch my whiskers at pages bright,
I hop through tiles and links made right.
A theme, a tweak, the catalog shorn—
I nibble bytes at early morn.
🥕🐇

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch theme-0.40.0.dev0

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/requirements.txt (1)

1-1: Pre-release floor may cause non-reproducible installs; consider pinning or bounding the range.

Using crate-docs-theme>=0.40.0.dev0 opts into pre-releases and allows upgrades to any newer dev/pre/final, which can drift CI builds. Prefer either:

  • Pin exactly to the intended dev cut for reproducibility, or
  • Bound within the 0.40.x line to avoid unexpected 0.41+ changes.

Two options:

- crate-docs-theme>=0.40.0.dev0
+ crate-docs-theme==0.40.0.dev0

or (stay on 0.40 train, accept newer dev/finals only within 0.40):

- crate-docs-theme>=0.40.0.dev0
+ crate-docs-theme>=0.40.0.dev0,<0.41.0.dev0
📜 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 sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fe57c50 and affd1c1.

📒 Files selected for processing (1)
  • docs/requirements.txt (1 hunks)
🔇 Additional comments (1)
docs/requirements.txt (1)

1-1: Pre-release verified and pip resolution confirmed

  • The crate-docs-theme 0.40.0.dev0 pre-release is published on PyPI.
  • The latest final release is 0.39.0.
  • Running pip download "crate-docs-theme>=0.40.0.dev0" successfully fetched the 0.40.0.dev0 wheel, confirming that CI will install this dev release when resolving the spec.

If targeting the dev build is intentional, no further changes are needed. Otherwise, consider pinning to the latest final version (0.39.0) or adjusting your version spec.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
docs/admin/create-user.md (1)

23-24: Consider unifying link style for external references (optional).

The page mixes {ref} with [](inv:...). Both are valid in MyST; choosing one consistently can reduce maintenance overhead. Given lines 28–31 use inv: links, you could switch lines 23–24 to the same style for consistency—or conversely migrate the inv: links to {ref} if all targets resolve via intersphinx.

Example using inv: style here:

-... first {ref}`install Crash <crate-crash:getting-started>` or {ref}`connect <connect>` ...
+... first [](inv:crate-crash:getting-started){.xref title="install Crash"} or {ref}`connect <connect>` ...

Or convert nearby inv: uses to {ref} if those labels resolve via intersphinx.

📜 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 sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between affd1c1 and b543efd.

📒 Files selected for processing (1)
  • docs/admin/create-user.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-23T04:22:52.562Z
Learnt from: amotl
PR: crate/cratedb-guide#235
File: docs/start/going-further.md:20-38
Timestamp: 2025-08-23T04:22:52.562Z
Learning: In the CrateDB Guide repository, the prefix `crate-reference:` in documentation links (like `crate-reference:index`) is an intersphinx reference that points to external content in the CrateDB Reference Manual documentation. These references are intentionally not pointing to local files within the repository.

Applied to files:

  • docs/admin/create-user.md
📚 Learning: 2025-08-14T19:02:43.308Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.308Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.

Applied to files:

  • docs/admin/create-user.md

@amotl amotl force-pushed the theme-0.40.0.dev0 branch from b543efd to 7f7cb33 Compare August 24, 2025 01:29
All content has been absorbed by `cratedb-guide` already.
Copy link
Contributor

@bmunkholm bmunkholm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the .dev0 versioning?

@amotl
Copy link
Member Author

amotl commented Aug 24, 2025

Why the .dev0 versioning?

If something is wrong, it will not be too contagious across all the repositories/projects which are pulling that package.

@amotl amotl merged commit c684fbc into main Aug 24, 2025
3 checks passed
@amotl amotl deleted the theme-0.40.0.dev0 branch August 24, 2025 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants