crossplane / crossplane/upjet

Duplication of text in generated API documentation

Open
#371 0 comments 1 reaction 0 assignees View on GitHub
bug docgen v2
Dominant language
Go
Stars
481
Forks
131
Avg merge
2d 1h
Merged PRs (30d)
11

Description

### What happened?

Upjet duplicates text in API documentation, sometimes starts mid sentence, and other times provides unrelated documentation.

Example:

[schedulingOptions](https://marketplace.upbound.io/providers/upbound/provider-datadog/v0.1.0/resources/datadog.upbound.io/Monitor/v1alpha1#doc:spec-forProvider-schedulingOptions)
array

(Block List) Configuration options for scheduling. (see below for nested schema) Configuration options for scheduling.
[customSchedule](https://marketplace.upbound.io/providers/upbound/provider-datadog/v0.1.0/resources/datadog.upbound.io/Monitor/v1alpha1#doc:spec-forProvider-schedulingOptions-customSchedule)
array

(Block List) Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used. (see below for nested schema) Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.

### How can we reproduce it?

Make any provider with Upjet and look at the API documentation, including provider-aws.

Contributor guide

Open the contributing guide

Research direction

Start by generating any provider with Upjet, including provider-aws, and inspect its API documentation for duplicated or unrelated descriptions. Trace the documentation-generation path from the generated output back to the source schema or templates. Done means descriptions appear once, start at the correct text, and match the documented field.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Bug
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.