ipfs/kubo

Gateway docs need to be updated to reflect supported features

Open

#10.234 geöffnet am 27. Nov. 2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Go (13.906 Stars) (2.725 Forks)batch import
P2effort/hoursexp/novicehelp wantedtopic/docs

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic understanding of IPFS gatewayFamiliarity with MarkdownRead docs/gateway.md
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.