posit-dev / posit-dev/rsconnect-python
documentation for API workflow
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 37
- Fork
- 28
- Merge medio
- 1g 3h
- PR unite (30g)
- 7
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i punti di ingresso rimanenti per l’utilizzo dell’API di RSConnectServer e deploy_python_fastapi, quindi esamina come era organizzata la documentazione dell’API rimossa. Redigi un documento narrativo in Markdown o Quarto che copra il workflow comunemente utilizzato e le API denominate; il lavoro è completo quando gli utenti possono seguire quel workflow senza la documentazione dell’API rimossa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100