Docs: include a 'How do I...?' table to direct on common tasks
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 150
- Forks
- 23
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die entsprechende Tabelle „How do I...?“ in der xarray-Dokumentation zu prüfen, und untersuche anschließend die bestehende Dokumentationsstruktur dieses Repositorys. Erstelle eine Dokumentationsseite, die gängige Benutzeraufgaben den jeweils relevanten Methoden, API-Referenzen, Beispielen, Tutorials und Rezepten zuordnet, sofern zutreffend; die Aufgabe ist abgeschlossen, wenn die Tabelle für die identifizierten Aufgaben diese Navigationslinks bereitstellt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100