Publish a reference for the Fabric API: sign-in, regions and plans, cluster create and update

Đang mở
#809 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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ả

content
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 instanceCount adds up to what a feature needs (a sharded cluster needs at least shards × minOwners instances);
  • that regionPlans in a PUT is 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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của HarperFast/documentation

Tất cả issue của HarperFast/documentation

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.