nushell / nushell/nushell.github.io

Add "Warning/Tip" to top of older Release Notes that they might have outdated info

Aperta
#1,501 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
258
Fork
561
Merge medio
3h 20m
PR unite (30g)
15

Descrizione

As mentioned #536, search results can surface some pretty old Release Notes that have outdated info. A couple of options:

  1. Leave it as it is

  2. Review each release note and edit to highlight outdated info

  3. Just add a warning header (yellow formatting in the theme) to the top of older (say 5 releases back and older) release notes with something like (first pass):

    These are the Release Notes for <version>. If you have arrived here via Search, please keep in mind that information here may (or may not ) be outdated. Features may have been renamed, functionality added or removed, or other changes may have been made after this Release. Please refer to the other documentation sources on this site for updated information.

I'd vote for the third, personally. Regarding 2 - I think Release Notes are a historical archive and shouldn't be changed post de defacto. It would also be a major (and continual) undertaking to review and update.

While the first option is a possibility, the point made in #536 is a fair one that I'd like to see addressed in some way.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Individua le Release Notes che coprono la quinta release più vecchia e quelle precedenti, quindi verifica come il tema rappresenta un'intestazione di avviso. Applica l'avviso proposto sulle informazioni obsolete alle note interessate senza riscriverne il contenuto storico. Il lavoro è completo quando le note più vecchie mostrano l'avviso in modo coerente, mentre le Release Notes più recenti rimangono invariate.

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

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 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.