ipfs/kubo

Gateway docs need to be updated to reflect supported features

Open

#10 234 ouverte le 27 nov. 2023

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
go
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of IPFS gatewayFamiliarity with MarkdownRead docs/gateway.md
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.