Publish a reference for the Fabric API: sign-in, regions and plans, cluster create and update
Maintainer thường phản hồi trong vòng 4 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- markdown
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start with fabric/cluster-creation-management.md on the referenced docs/fabric-sharded-clusters branch and review related issue #539. Confirm the public API surface with the Fabric team, then document authentication, region and plan listing, cluster creation, updating, deletion, and error responses in a new fabric/ reference page. Done when the agreed behavior is documented and feature sections can link to the reference.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Gap
The Fabric docs show Fabric API requests only inside feature sections. The new Sharded Clusters section on fabric/cluster-creation-management.md (branch docs/fabric-sharded-clusters) uses POST /Login/, POST /Cluster/, GET /Region/, GET /Plan/ and PUT /Cluster/<cluster id>/ in passing, because creating a sharded cluster is API-only until Studio offers it. Nothing documents those endpoints as such:
- which fields a cluster create needs, and what each one does;
- how to choose a plan and regions whose
instanceCountadds up to what a feature needs (a sharded cluster needs at leastshards×minOwnersinstances); - that
regionPlansin aPUTis the complete set of regions, so a region left out is removed; - how an account that signs in to Studio without a password authenticates;
- the error responses.
Impact
Each API-only feature re-explains sign-in and the create body in its own section, and a reader sizing a sharded cluster has to work out plan and region choice by trial and error.
Suggested fix
Add a fabric/ reference page for the Fabric API at https://fabric.harper.fast: authentication, listing regions and plans, and creating, updating and deleting a cluster. Agree the public surface with the Fabric team first, so the page documents only what is meant to be relied on. Feature sections such as Sharded Clusters then link to it instead of restating it. Related: #539 (a UI-independent reference for account, organization and cluster setup).
Review-Deferral: 8541bd35fc1a3d36 severity=nit category=documentation
🤖 Generated by Anthropic Claude Code (Claude Opus); posted via @kriszyp.
- Ngôn ngữ chính
- MDX
- Star
- 9
- Fork
- 9
- Merge trung bình
- 5 ngày 5 giờ
- Pull request đã merge (30 ngày)
- 48
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của HarperFast/documentation
-
Document http.maxRequestBodySize (REST, MCP application endpoint, and operations API body limits)Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
HarperFast/documentation#806 ·
Maintainer thường phản hồi trong vòng 4 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
HarperFast/documentation#803 ·
Maintainer thường phản hồi trong vòng 4 ngày
-
content
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
HarperFast/documentation#785 ·
Maintainer thường phản hồi trong vòng 4 ngày
-
content
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 68/100
HarperFast/documentation#770 ·
Maintainer thường phản hồi trong vòng 4 ngày
-
content
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
HarperFast/documentation#769 ·
Maintainer thường phản hồi trong vòng 4 ngày
Tất cả issue của HarperFast/documentation
Issue tương tự
-
入群码过期Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 84/100
aliyun/ai-agent-handbook#29 · 1 bình luận ·
-
docs documentation need-triage SaaS
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)Đang mởsync-en
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)Đang mởsync-en
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 73/100
sleepyviper1213/redis#30 ·