Docs: include a 'How do I...?' table to direct on common tasks
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 42/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par examiner le tableau équivalent « How do I...? » dans la documentation de xarray, puis inspectez la structure de documentation existante de ce dépôt. Créez une page de documentation qui associe les tâches courantes des utilisateurs aux méthodes, références d’API, exemples, tutoriels et recettes pertinents, le cas échéant ; le travail est terminé lorsque le tableau fournit ces liens de navigation pour les tâches identifiées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Python
- Étoiles
- 150
- Forks
- 23
- Merge moyen
- 1 j 11 h
- PR mergées (30 j)
- 2
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de NCAS-CMS/cf-python
-
code tidy
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
bug?
-
release
-
enhancement
-
error from netCDF in cf.write Ouvertebug
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
Toutes les issues de NCAS-CMS/cf-python
Issues similaires
-
agent-ready documentation needs-triage
Difficulté 1/5 1-3 heures Accessibilité débutants 88/100
-
documentation
Difficulté 1/5 Moins d'une heure Accessibilité débutants 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
-
Add https://search.jeremyh.xyz/ Ouverteinstance instance add
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
searxng/searx-instances#939 · 1 commentaire ·
-
area-deployment area-integrations triage:bot-seen
Difficulté 2/5 Une demi-journée Accessibilité débutants 86/100