ipfs/kubo

Gateway docs need to be updated to reflect supported features

Open

#10.234 aperta il 27 nov 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Go (2725 fork)batch import
P2effort/hoursexp/novicehelp wantedtopic/docs

Metriche repository

Star
 (13.906 star)
Metriche merge PR
 (Merge medio 9g 4h) (27 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Rivedi la documentazione attuale in docs/gateway.md per comprendere la descrizione esistente del comportamento di elenco delle directory. Quindi controlla l'implementazione del gateway IPFS per la nuova funzionalità di reindirizzamento per descrivere accuratamente il comportamento aggiornato. Aggiorna il file markdown per sostituire la vecchia descrizione con quella nuova, assicurando chiarezza su quando avviene il reindirizzamento.
Tech stack
go
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic understanding of IPFS gatewayFamiliarity with MarkdownRead docs/gateway.md
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80