Docs: include a 'How do I...?' table to direct on common tasks
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza revisando la tabla equivalente «How do I...?» de la documentación de xarray y, a continuación, inspecciona la estructura de documentación existente de este repositorio. Crea una página de documentación que relacione las tareas habituales de los usuarios con los métodos, referencias de API, ejemplos, tutoriales y recetas pertinentes cuando corresponda; se considerará completado cuando la tabla proporcione esos enlaces de navegación para las tareas identificadas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
As part of our summit this week, we have identified that users would benefit from a page in the documentation which centers around a table which list common tasks that a user might want to do and maps them to relevant methods and their API reference pages; examples; and documentation sections.
A great example of this is an equivalent table in the xarray docs. As well as pointing to methods of direct relevance as per that table, we can include some extra columns which point to relevant sections of the Tutorial and relevant recipes, where applicable.
- Lenguaje dominante
- Python
- Estrellas
- 150
- Forks
- 23
- Merge medio
- 1 d 11 h
- PR fusionados (30 d)
- 2
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 NCAS-CMS/cf-python
-
code tidy
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
bug?
-
release
-
enhancement
-
error from netCDF in cf.write Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
Todos los issues de NCAS-CMS/cf-python
Issues similares
-
agent-ready documentation needs-triage
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
-
Add https://search.jeremyh.xyz/ Abiertoinstance instance add
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
searxng/searx-instances#939 · 1 comentario ·
-
area-deployment area-integrations triage:bot-seen
Dificultad 2/5 Medio día Aptitud para principiantes 86/100