Publish a reference for the Fabric API: sign-in, regions and plans, cluster create and update
维护者通常 4 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- markdown
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- MDX
- 星标
- 9
- 派生
- 9
- 平均合并
- 5 天 5 小时
- 30 天内合并 PR
- 48
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
HarperFast/documentation 的其他 Issue
-
Document http.maxRequestBodySize (REST, MCP application endpoint, and operations API body limits)未关闭
难度 2/5 1-3 小时 新手友好度 88/100
HarperFast/documentation#806 ·
维护者通常 4 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
HarperFast/documentation#803 ·
维护者通常 4 天内回复
-
content
难度 2/5 1-3 小时 新手友好度 65/100
HarperFast/documentation#785 ·
维护者通常 4 天内回复
-
content
难度 2/5 半天 新手友好度 68/100
HarperFast/documentation#770 ·
维护者通常 4 天内回复
-
content
难度 2/5 1-3 小时 新手友好度 74/100
HarperFast/documentation#769 ·
维护者通常 4 天内回复
查看 HarperFast/documentation 的全部 Issue
相似的 Issue
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)未关闭sync-en
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复
-
Documentation: Resolve Doxygen section label collision, ref parsing, and parameter warnings可能已有人在做 @patelshivani2283-lab 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
external
难度 1/5 1 小时以内 新手友好度 82/100
langchain-ai/docs#7808 ·
维护者通常 1 天内回复
-
ACK_WAITING HELP_WANTED UPDATE_CS
难度 2/5 1-3 小时 新手友好度 76/100
OWASP/CheatSheetSeries#3000 ·
维护者通常 1 天内回复
-
needs triage 📥
难度 2/5 1-3 小时 新手友好度 72/100
ethereum/ethereum-org-website#19804 ·
维护者通常 1 天内回复