pulumi / pulumi/pulumi-java

Add descriptions in SDK docs

Open
#1,663 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area/docs good-first-issue kind/enhancement language/java
Dominant language
Java
Stars
85
Forks
26
Avg merge
11h 49m
Merged PRs (30d)
22

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the SDK's packages, interfaces, and classes to identify undocumented or incomplete descriptions. Add concise descriptions that explain each package's purpose and indicate packages not intended for external Pulumi use; consider linting only if the existing documentation tooling supports it. Done means the affected SDK documentation has useful coverage across these areas.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.