Guide for writing guides
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
Inizia con la guida esistente per la scrittura dei tutorial all’indirizzo nix.dev/contributing/documentation/writing-a-tutorial, poi leggi la discussione collegata del team della documentazione e la guida Diátaxis. Documenta la struttura e lo stile di scrittura distinti delle guide, incluso in che modo differiscono dai tutorial; il lavoro sarà considerato completato quando le nuove indicazioni saranno pubblicate sul sito della documentazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
We have a guide for writing tutorials: https://nix.dev/contributing/documentation/writing-a-tutorial
But guides address a different need: looking up contextualised facts to execute common tasks or implement common workflows. That requires a particular structure and writing style, which is usually much more condensed and can leave out many details.
Related discussion on how to structure guides: https://discourse.nixos.org/t/2023-05-04-documentation-team-meeting-notes-45/27874#what-to-do-with-all-the-guides-2
- Lingua principale
- Nix
- Stelle
- 4k
- Fork
- 343
- Merge medio
- 20h 27m
- PR unite (30g)
- 10
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
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.
Altre issue di NixOS/nix.dev
-
site
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 76/100
NixOS/nix.dev#1224 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
I maintainer di solito rispondono entro 1 giorno
-
FAQ (idea draft)Apertasite
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
I maintainer di solito rispondono entro 1 giorno
-
site
Difficoltà 5/5 Più di una settimana Idoneità per principianti 38/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di NixOS/nix.dev
Issue simili
-
sync-en
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
area:docs phase:release priority:p0 type:test
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
-
Add an MCP server: imageatApertaneeds-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
stacklok/toolhive-catalog#1890 ·
I maintainer di solito rispondono entro 1 giorno
-
area:docs documentation effort:M ready-for-agent
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
mczielinski/ob-analytics#423 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno