ipfs/kubo

Gateway docs need to be updated to reflect supported features

Open

#10,234 opened on 2023年11月27日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
P2effort/hoursexp/novicehelp wantedtopic/docs

説明

Checklist

  • My issue is specific & actionable.
  • I am not suggesting a protocol enhancement.
  • I have searched on the issue tracker for my issue.

Description

https://github.com/ipfs/kubo/blob/master/docs/gateway.md For convenience, the gateway (mostly) acts like a normal web-server when serving a directory:

If the directory contains an index.html file: If the path does not end in a /, append a / and redirect. This helps avoid serving duplicate content from different paths.† Otherwise, serve the index.html file. Dynamically build and serve a listing of the contents of the directory.

Among the above functions, a new page redirection function is added for directories without index.html, such as redirecting to ipfs.io. No need to directly build directory listing contents

コントリビューターガイド

技術スタック
go
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic understanding of IPFS gatewayFamiliarity with MarkdownRead docs/gateway.md
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
Review the current documentation in docs/gateway.md to understand the existing description of directory listing behavior. Then check the IPFS gateway implementation for the new redirection feature to accurately describe the updated behavior. Update the markdown file to replace the old description with the new one, ensuring clarity about when redirection occurs.
Gateway docs need to be updated to reflect supported features · ipfs/kubo#10234 | Good First Issue