Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Troubleshooting docs

Aperta
  • Qualcosa non va?
#3,331 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando gli argomenti esistenti di risoluzione dei problemi e il relativo ordine di priorità per area funzionale, quindi consulta L2 e L3 per individuare gli scenari mancanti. Il lavoro è completato quando sono state identificate le lacune rilevanti e la guida alla risoluzione dei problemi è stata aggiornata basandosi sui sintomi degli utenti, sui messaggi di errore e su soluzioni concrete, anziché su limitazioni generali.

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

Descrizione

epic

This epic is to track updates and doc bugs across the troubleshooting docs.

Notes from discussion with Alasdair:

Troubleshooting docs should take the approach of: "I'm doing x and getting this error. The solution is y." rather than just listing "limitations" or things that someone is just expected to remember. Troubleshooting docs, to be useful, need to be in a framing than enables the user to search/browse for something that describes the unfortunate situation that they're currently in. Then take their hand and make it all better. :)

The difference between troubleshooting and operations docs:

  • Troubleshooting Liberty is the kind of thing in this topic where you get a message and here's what to do about it.
  • Whereas, not analytics, logging, etc that we'd put in Operations.

Talk to L2 and L3:

  • Some of the tech docs online are troubleshooting "if you see x, then you need to do y".
  • talk to L2 and L3 to work out if there's things that we haven't covered that should be here

When prioritising troubleshooting work, follow the priority order of the functional areas of topics we've already got, in general.

Lingua principale
Nessun dato sulla lingua
Stelle
14
Fork
58
Merge medio
1h 4m
PR unite (30g)
21

Preparare l'ambiente

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.

Altre issue di OpenLiberty/docs

Tutte le issue di OpenLiberty/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.