posit-dev / posit-dev/rsconnect-python
documentation for API workflow
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 37
- Forks
- 28
- Merge moyen
- 1 j 3 h
- PR mergées (30 j)
- 7
Description
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.
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.
Piste de recherche
Commencez par localiser les points d’entrée restants d’utilisation de l’API pour RSConnectServer et deploy_python_fastapi, puis examinez comment la documentation d’API supprimée était organisée. Rédigez un document narratif au format Markdown ou Quarto couvrant le workflow couramment utilisé et les API nommées ; le travail est considéré comme terminé lorsque les utilisateurs peuvent suivre ce workflow sans la documentation d’API supprimée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api, documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100