stackabletech / stackabletech/documentation
Explore alternatives to Antora for documentation
Nessuno ha ancora preso questa issue.
- Lingua principale
- CSS
- Stelle
- 13
- Fork
- 14
- Merge medio
- 4g 8h
- PR unite (30g)
- 10
Descrizione
[!IMPORTANT]
This issue is not a commitment to replacing Antora. It is just to record the frustrations of the current documentation workflow, look into alternatives, do timeboxed trials, and understand what we then lose by switching.
Acceptance
- List shortcomings of the status-quo (Antora)
- List things we like about the status-quo (Antora)
- Timeboxed trial of select alternatives to understand the tradeoffs
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Non vengono indicati file, test o punti di ingresso. Inizia documentando il workflow di documentazione di Antora, separandone i punti deboli dai punti di forza, quindi esegui prove a tempo limitato di alternative selezionate e documenta i compromessi e le perdite per ciascuna opzione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100