fsharp / fsharp/fsharp-core-docs

Generate hash for index.json requests (FSharp.Formatting issue)

Aperta
#33 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
fsdocs
Lingua principale
Nessun dato sulla lingua
Stelle
37
Fork
20
Merge medio
6m
PR unite (30g)
1

Descrizione

The index.json search index cached by browsers may become out of date as the site gets refreshed

This is an FSharp.Formatting issue (specifically in fsdocs-search.js) noted by @baronfel in https://github.com/fsharp/fsharp-core-docs/pull/27#issuecomment-667561113

> > Cool. How do we check that? Here's the request: fsprojects/FSharp.Formatting@master/docs/content/fsdocs-search.js#L14
>
> Regarding this point, I'd suggest that that content rendered by the templating engine render the content, and provide a hashed value for this specific content
>
> Then, when rendering links/src elements to generated content files, append the hash to the query string. This would mean that urls like the one in the search JS you linked would need to be templated as well. Same for css links in the html head elements, etc.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Start with docs/content/fsdocs-search.js at line 14 and trace the templating path that emits index.json and generated asset URLs. Determine how generated links and CSS or script references are produced; done means refreshed content receives a hash query value so browsers do not reuse stale index.json responses.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
fsharp, javascript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.