ipfs/kubo

Gateway docs need to be updated to reflect supported features

Open

#10,234 opened on Nov 27, 2023

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

Description

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

Contributor guide

Tech stack
go
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of IPFS gatewayFamiliarity with MarkdownRead docs/gateway.md
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.