posit-dev / posit-dev/rsconnect-python
documentation for API workflow
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 37
- Forks
- 28
- Merge medio
- 1 d 3 h
- PR fusionados (30 d)
- 7
Descripción
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.
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.
Línea de trabajo
Comienza localizando los puntos de entrada restantes para el uso de la API de RSConnectServer y deploy_python_fastapi; después, revisa cómo estaba organizada la documentación de la API eliminada. Redacta un documento narrativo en Markdown o Quarto que cubra el flujo de trabajo utilizado habitualmente y las API nombradas; se considera terminado cuando los usuarios pueden seguir ese flujo de trabajo sin la documentación de la API eliminada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100