haskell / haskell/hackage-server

Mark all pages for a deprecated package as deprecated

Offen
#263 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

component: ux enhancement
Vorherrschende Sprache
Haskell
Sterne
467
Forks
226
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

When a package is deprecated, it should not be necessary to go to the 'contents' section to see that it is deprecated.

The warning should be at the top of every page.

Here is an example: the following link is the first result for the query 'cprg hackage' on google. The package is deprecated.

http://hackage.haskell.org/package/crypto-random-api-0.2.0/docs/Crypto-Random-API.html

But that is nowhere to be seen, only on the main page:

http://hackage.haskell.org/package/crypto-random-api-0.2.0

See also haskell/haddock#328

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Hauptseite des Pakets mit der dokumentierten Modulseite im verlinkten Beispiel crypto-random-api zu vergleichen, und lies anschließend das zugehörige haskell/haddock#328-Issue. Verfolge, wo die Veraltungswarnung des Pakets gerendert wird, und stelle sicher, dass die Warnung oben auf jeder Dokumentationsseite erscheint, nicht nur im Inhaltsbereich.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
haskell
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.