Skip to content

feat: connections docs#185

Open
liyouzhi666 wants to merge 2 commits intomasterfrom
feat/connections-docs
Open

feat: connections docs#185
liyouzhi666 wants to merge 2 commits intomasterfrom
feat/connections-docs

Conversation

@liyouzhi666
Copy link
Copy Markdown

@liyouzhi666 liyouzhi666 commented Apr 14, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Connections docs: overview, intro, index, and a detailed "How To / Using Connections" guide.
    • Includes step-by-step UI workflows, lifecycle operations (create/duplicate/edit/enable/delete), verification and deletion semantics, and guidance on updating dependent workloads.
    • Documents supported connection kinds (URI, OCI registry, S3), runtime behavior for consuming connections, metadata usage, and example manifests.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Apr 14, 2026

Deploying alauda-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: d28ec68
Status: ✅  Deploy successful!
Preview URL: https://a0cc56ed.alauda-ai.pages.dev
Branch Preview URL: https://feat-connections-docs.alauda-ai.pages.dev

View logs

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 14, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c618b8c9-1dbe-4ecd-a638-bc296cf62cf7

📥 Commits

Reviewing files that changed from the base of the PR and between 579302e and d28ec68.

📒 Files selected for processing (1)
  • docs/en/connections/how_to/using_connections.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/en/connections/how_to/using_connections.mdx

Walkthrough

Added new documentation pages for a Connections feature (index, overview, intro, how-to) and updated an existing model storage doc to cross-reference the new "Using Connections" guide. All changes are documentation-only.

Changes

Cohort / File(s) Summary
Connections docs: root & overview
docs/en/connections/index.mdx, docs/en/connections/overview/index.mdx, docs/en/connections/overview/intro.mdx
Added Connections index and overview pages with frontmatter and intro describing project-scoped connection secrets, connection types (ConfigMaps in kube-public), and supported kinds (URI, OCI, S3).
Connections docs: how-to guide
docs/en/connections/how_to/index.mdx, docs/en/connections/how_to/using_connections.mdx
Added how-to landing and detailed guide explaining create/update/delete flows, UI steps, verification, connection type lifecycle, runtime secret mounting (imagePullSecret, ServiceAccount), annotations, and example Kubernetes manifests.
Cross-reference update
docs/en/model_inference/model_management/functions/model_storage.mdx
Added a cross-reference to the new "Using Connections" page and minor newline cleanup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • Add Model Storage #89 — touched docs/en/model_inference/model_management/functions/model_storage.mdx, which is also updated here.

Suggested reviewers

  • zhaomingkun1030
  • typhoonzero

Poem

🐰 New pages sprout where docs paths meet,
Connections mapped in tidy rows and neat,
Secrets, types, and examples hop in line,
A little guide to set your endpoints fine,
Hooray — the doc warren feels complete! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'feat: connections docs' accurately describes the main change: adding comprehensive documentation for the Connections feature across multiple new documentation pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/connections-docs

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.

Copy link
Copy Markdown

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/en/connections/how_to/using_connections.mdx`:
- Line 134: Update the wording that currently reads "cluster-level configmaps"
to use Kubernetes' canonical Kind capitalization "cluster-level ConfigMaps" in
the sentence that says "The current implementation uses project secrets for
connections and cluster-level configmaps for connection types" in
using_connections.mdx; also scan the same document for other occurrences of
"configmaps" and normalize them to "ConfigMaps" for consistency.
- Around line 33-34: Update the two list labels to use hyphenated compound
modifiers for consistency: change "OCI compliant registry" to "OCI-compliant
registry" and "S3 compatible object storage" to "S3-compatible object storage"
in the docs content so the labels match the suggested wording; search for those
exact label strings in the file to locate and replace them.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d77d2b6b-8548-41db-ac61-096f44033d89

📥 Commits

Reviewing files that changed from the base of the PR and between ee19dcd and 579302e.

📒 Files selected for processing (6)
  • docs/en/connections/how_to/index.mdx
  • docs/en/connections/how_to/using_connections.mdx
  • docs/en/connections/index.mdx
  • docs/en/connections/overview/index.mdx
  • docs/en/connections/overview/intro.mdx
  • docs/en/model_inference/model_management/functions/model_storage.mdx

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