Guide for writing guides
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza con la guía existente para escribir tutoriales en nix.dev/contributing/documentation/writing-a-tutorial, luego lee la discusión del equipo de documentación enlazada y la guía de Diátaxis. Documenta la estructura y el estilo de escritura propios de las guías, incluido en qué se diferencian de los tutoriales; se considerará terminado cuando la nueva guía se publique en el sitio de documentación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Nix
- Estrellas
- 4k
- Forks
- 343
- Merge medio
- 1 d 22 h
- PR fusionados (30 d)
- 10
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NixOS/nix.dev
-
site
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 76/100
NixOS/nix.dev#1224 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
Los mantenedores suelen responder en 1 día
-
FAQ (idea draft)Abiertosite
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
site
Dificultad 5/5 Más de una semana Aptitud para principiantes 38/100
Los mantenedores suelen responder en 1 día
Todos los issues de NixOS/nix.dev
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
huggingface/diffusers#15170 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 62/100
PyLops/pyproximal#280 ·
Los mantenedores suelen responder en 1 día
-
question
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
FoodOntology/foodon#375 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
daniel-ospina/tortoise#10644 ·
Los mantenedores suelen responder en 1 día