Clarify IPFS node/gateway usage in retrieve quickstart

オープン 初心者向け
#2,258 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
65/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
領域
documentation

調査の方向性

docs/quickstart/retrieve.md から始め、Kubo を使った CID の取得、Helia Verified Fetch、IPFS Gateway について説明しているセクションを確認します。どのアプローチがノードまたはゲートウェイを使用するのか、また取得が信頼済みなのか検証済みなのかを明確にします。各例にそのカテゴリと信頼性または検証の状態が明示されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

kind/suggestion need/triage

I've read through the retrieve quickstart and didn't find it as clear as it could be. I like the distinction between IPFS node vs. gateway and trusted vs. verified. Though in the later section it's not always clear to me to which category something belongs.

More concretely:

  • Fetching the CID with Kubo: I would welcome a sentence that states that as it's a IPFS node it's of course verified.
  • Verified retrieval with Helia Verified Fetch: It's not clear whether it's using an IPFS node or a gateway (it's using both)
  • Fetching the CID with an IPFS Gateway: Mention that those are trusted and not verified.
主要言語
Go
スター
334
フォーク
503
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ipfs/ipfs-docs のほかの issue

ipfs/ipfs-docs の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。