Improve autogenerated SDK documentation
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 30/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Beginne mit der Untersuchung der generierten Dokumentation unter crossplane.github.io/function-sdk-python/function.html und der aus Protobuf generierten Dokumentationsausgabe des Python SDK. Prüfe, wie die aktuelle Dokumentation generiert wird, einschließlich der Frage, ob Sphinx oder MkDocs bereits verwendet wird. Als abgeschlossen gilt die Aufgabe, wenn die Dokumentation eine nützliche Einstiegsseite, Versionierung und eine Abdeckung des aus Protobuf generierten Codes bietet und der Ansatz nur wenig Wartungsaufwand erfordert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
What problem are you facing?
We have autogenerated SDK documentation at https://crossplane.github.io/function-sdk-python/function.html, but it's not great.
Some things that could be improved:
- There's no versioning - the generated docs always and only reflect the
mainbranch. - The landing page is empty.
- There's no documentation for the protobuf generated code.
Documentation for the protobuf generated code seems like it would be very valuable, since there's not much else to this SDK apart from a few utilities. Unfortunately the code itself doesn't seem to have docstrings, despite the protobuf messages it's generated from having them.
How could this Function help solve your problem?
- Figure out if there's some way to copy docstrings from the protobuf schema to the generated code.
- Use a better docs tool (Sphinx, mkdocs, etc). Ideally something low maintenance.
- Vorherrschende Sprache
- Python
- Sterne
- 12
- Forks
- 15
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 7
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus crossplane/function-sdk-python
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
enhancement
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 42/100
-
enhancement
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
crossplane/function-sdk-python#199 · 4 Kommentare · 3 Reaktionen ·
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
crossplane/function-sdk-python#129 · 1 Kommentar ·
-
Dependency Dashboard Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 10/100
Alle Issues in crossplane/function-sdk-python
Ähnliche Issues
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
canonical/paas-charm#368 · 1 Kommentar ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
tech debt
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
StevenBlack/hosts#3256 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
qualcomm/qai-appbuilder#275 ·