JuliaDocs/Documenter.jl

Prevent leaking trackable pageview stats to CDNs by default

Offen

#2.391 geöffnet am 06.01.2024

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Julia (513 Forks)batch import
Format: HTMLhelp wanted

Repository-Metriken

Stars
 (910 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

This is a kinda continuation of my previous comment here: https://github.com/JuliaDocs/Documenter.jl/issues/2159#issuecomment-1879633205 from #2159 .

It would be great if the generated HTML didn't send referrer URLs in headers, thus preventing the CDNs the default access to (very easily trackable) user page load stats by default. In turn, this would allow much better compliance with various privacy protection guidelines, incl. GDPR.

For the beginning, I think that just pasting a referrerpolicy="no-referrer" into all <link> tags that point to external CDNs would be more than sufficient. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link#referrerpolicy for details there.

Thanks!

Contributor Guide

Research-Richtung
Das Issue schlägt vor, referrerpolicy='no referrer' zu allen <link> Tags hinzuzufügen, die auf externe CDNs verweisen. Die Hauptaufgabe besteht darin, zu lokalisieren, wo diese Link Tags im Documenter.jl Codebase generiert werden, wahrscheinlich in der HTML Vorlage oder im Generatorcode (z.B. src/Documenter/Builder.jl oder ähnlich). Der Beitragende sollte auch die im Issue verlinkte vorherige Diskussion für den Kontext heranziehen. Die Änderung ist unkompliziert und lokalisiert, erfordert nur das Hinzufügen des Attributs zu den relevanten Link Elementen.
Tech Stack
Keine
Domain
documentationfrontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
HTML
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80