posit-dev / posit-dev/rsconnect-python
documentation for API workflow
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 37
- Forks
- 28
- Ø Merge
- 1 T. 3 Std.
- Gemergte PRs (30 T.)
- 7
Beschreibung
With the removal of the API docs, it would be good for users to have some sort of documentation to show how to use rsconnect-python API in a narrative way.
More than happy to start a PR of a markdown/Quarto file for the bits that I tend to use a lot (RSConnectServer, deploy_python_fastapi, etc) to start this off! LMK what format is most useful to you all.
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 verbleibenden API-Nutzungseinstiegspunkte für RSConnectServer und deploy_python_fastapi zu ermitteln, und prüfe anschließend, wie die entfernte API-Dokumentation organisiert war. Verfasse ein erzählendes Markdown- oder Quarto-Dokument, das den häufig verwendeten Workflow und die benannten APIs abdeckt; als erledigt gilt die Aufgabe, wenn Nutzer diesem Workflow ohne die entfernte API-Dokumentation folgen können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100