Publish a reference for the Fabric API: sign-in, regions and plans, cluster create and update
メンテナーはふだん 4 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR(30日)
- 48
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
入群码过期オープン
難易度 1/5 1時間未満 初心者へのやさしさ 84/100
aliyun/ai-agent-handbook#29 · コメント 1 件 ·
-
docs documentation need-triage SaaS
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)オープンsync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
[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
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
sleepyviper1213/redis#30 ·