Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Sep 15, 2025

@amotl amotl added the reorganize Moving content around, inside and between other systems. label Sep 15, 2025
@coderabbitai
Copy link

coderabbitai bot commented Sep 15, 2025

Walkthrough

Adds a new MLflow integration page, links it from the integrations index, and replaces the detailed MLflow content on the ML topic page with a short seealso pointing to the new page.

Changes

Cohort / File(s) Summary
Integrations index update
docs/integrate/index.md
Inserts mlflow/index into the integrations toctree between mindsdb/index and mongodb/index.
New MLflow integration page
docs/integrate/mlflow/index.md
Adds a dedicated MLflow integration doc describing the mlflow-cratedb adapter, linking tutorials/notebooks, badges (README/GitHub/Colab), and external references.
Topic ML page consolidation
docs/topic/ml/index.md
Removes the embedded MLflow section and references; replaces it with a brief line and a seealso linking to the new MLflow integration page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

new content

Suggested reviewers

  • hammerhead
  • kneth

Poem

A twitch of whiskers, a joyful hop,
I stitched a page where MLflow can stop.
Links and notebooks snug in a row,
Down the burrow where model logs go.
🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title "MLflow: Refactor section to dedicated page" accurately and concisely summarizes the main change in this PR—extracting MLflow content into a dedicated docs/integrate/mlflow/index.md and updating related indexes as shown in the raw summary. It is short, specific, and directly related to the changeset without extraneous noise. This makes the primary intent clear to reviewers.
Description Check ✅ Passed The description is brief but on-topic: it labels the change as a refactor, provides a preview link, and references GH-313 which directly relate to the documentation changes in the PR. Although minimal, it meets the lenient criterion that the description be related to the changeset. Reviewers have enough context to proceed or request more detail if needed.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mlflow

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e473a4 and 499487c.

📒 Files selected for processing (3)
  • docs/integrate/index.md (1 hunks)
  • docs/integrate/mlflow/index.md (1 hunks)
  • docs/topic/ml/index.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/integrate/index.md
  • docs/integrate/mlflow/index.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: Build docs
🔇 Additional comments (1)
docs/topic/ml/index.md (1)

62-65: MLflow refactor LGTM — anchor verified

Anchor (mlflow) found at docs/integrate/mlflow/index.md:1; {ref}mlflow will resolve.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotl amotl marked this pull request as ready for review September 15, 2025 23:36
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 (2)
docs/topic/ml/index.md (1)

62-64: Optional: add a one‑liner for context/SEO.

Consider preceding the seealso with a sentence like “Use MLflow with CrateDB for experiment tracking and model registry,” then the seealso. Keeps topical relevance on this page.

docs/integrate/mlflow/index.md (1)

15-22: Minor wording nit.

Prefer “open‑source” (hyphenated) for consistency with other pages.

-[MLflow] is an open source platform
+[MLflow] is an open‑source platform
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 427d701 and 5e473a4.

📒 Files selected for processing (3)
  • docs/integrate/index.md (1 hunks)
  • docs/integrate/mlflow/index.md (1 hunks)
  • docs/topic/ml/index.md (1 hunks)
⏰ 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: Build docs
🔇 Additional comments (4)
docs/integrate/index.md (1)

50-51: LGTM; position is consistent.

Placed after mindsdb and before mongodb; matches alphabetical grouping.

docs/integrate/mlflow/index.md (2)

1-7: Anchor and hero/logo block look fine.

Label “(mlflow)=” enables {ref} links; image has alt text and lazy loading.


27-69: Approve — content structure and links verified.

Info‑cards, tags and badges match existing doc patterns. External links are reachable; the MLflow tracking URL returns a 301 redirect — optional: update that link to its canonical target to avoid the redirect.

docs/topic/ml/index.md (1)

62-64: Approve — mlflow seealso resolves

Confirmed: (mlflow) anchor present in docs/integrate/mlflow/index.md:1 and toctree entry present in docs/integrate/index.md:50.

@amotl amotl requested review from hammerhead and kneth September 15, 2025 23:52
@amotl amotl merged commit 2792f15 into main Sep 16, 2025
3 checks passed
@amotl amotl deleted the mlflow branch September 16, 2025 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants