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

未关闭
#809 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 4 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
markdown
领域
documentation

调研方向

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 内容生成。

描述

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.

主要语言
MDX
星标
9
派生
9
平均合并
5 天 5 小时
30 天内合并 PR
48

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

HarperFast/documentation 的其他 Issue

查看 HarperFast/documentation 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。