pulumi / pulumi/pulumi-java

Cross-link Javadocs in reference API docs

Open
#484 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/docs kind/enhancement
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

Once we publish javadocs we need to fill in the following placeholder so that API docs can link to the javadocs.

// TODO revisit once javadocs are published.
//
// Not every language currently supports this. For Python docsgen the
// implementation returns "" also.
//
// For an example of a language that supports this, check out Go.
//
// When visiting https://www.pulumi.com/registry/packages/aws/api-docs/s3/bucket/ see:
//
//     func NewBucket(ctx *Context, name string, args *BucketArgs, opts ...ResourceOption)
//
// Context, BucketARgs and ResourceOption get linked to Go API docs.
//
// For Java we could link to JavaDoc when appropriate.
func (d DocLanguageHelper) GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string {
	return ""
}
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 at DocLanguageHelper.GetDocLinkForPulumiType, the entry point named in the issue, and compare it with the Go implementation mentioned there. Investigate how JavaDocs are published and how Java type names map to their API documentation. Done means generated reference API pages link relevant Java types to the published JavaDocs.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.