Add descriptions in SDK docs

Aperta
#1,663 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia esaminando i pacchetti, le interfacce e le classi dell'SDK per identificare descrizioni non documentate o incomplete. Aggiungi descrizioni concise che spieghino lo scopo di ogni pacchetto e indichino i pacchetti non destinati all'uso esterno di Pulumi; considera il linting solo se gli strumenti di documentazione esistenti lo supportano. Il lavoro è completato quando la documentazione interessata dell'SDK offre una copertura utile in queste aree.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area/docs good-first-issue kind/enhancement language/java

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

It would be helpful to add descriptions to the packages, interfaces, and classes.

Packages are particularly bare, so a sentence on what the package is about would be helpful for navigating the docs. It would also be helpful to note when a package is not really meant for external consumption in Pulumi programs (.internal implies this, but codegen is also probably not for use by end users either):

Image

Coverage in classes is better, but still not complete:

Image

Adding linting would be cool if it's easy enough.

Affected area/feature
Lingua principale
Java
Stelle
85
Fork
26
Merge medio
11h 49m
PR unite (30g)
22

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pulumi/pulumi-java

Tutte le issue di pulumi/pulumi-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.