Skip to content

Link the published Java SDK API reference from the Java SDK docs#69433

Merged
jason810496 merged 2 commits into
apache:mainfrom
jason810496:docs/java-sdk-api-reference-link
Jul 6, 2026
Merged

Link the published Java SDK API reference from the Java SDK docs#69433
jason810496 merged 2 commits into
apache:mainfrom
jason810496:docs/java-sdk-api-reference-link

Conversation

@jason810496

Copy link
Copy Markdown
Member

Why

The Java SDK guide left an AIP-108 TODO in place of a Javadoc link. The docs pipeline now targets https://airflow.apache.org/docs/java-sdk/stable/, so the placeholder can become a real link.

What


Was generative AI tooling used to co-author this PR?

The interface-based API section pointed readers at the published JavaDoc
without a link, with a TODO left from AIP-108 waiting for the docs site
location to exist. The Javadoc publishing pipeline now targets
https://airflow.apache.org/docs/java-sdk/stable/, so the placeholder can
become a real link, matching how other SDK references are linked.
@jason810496 jason810496 requested a review from uranusjr July 6, 2026 06:07
@jason810496 jason810496 self-assigned this Jul 6, 2026
@jason810496 jason810496 added kind:documentation AIP-108: java-sdk Change this to an 'area:' label after AIP acceptance. backport-to-v3-3-test Backport to v3-3-test labels Jul 6, 2026
Comment thread airflow-core/docs/authoring-and-scheduling/language-sdks/java.rst Outdated
The site on airflow.apache.org is an HTML rendering of the API, not an
actual Javadoc rendering; Javadoc is bundled with the released artifacts
instead. The term also fails the docs spell check.
@jason810496 jason810496 merged commit 66798f9 into apache:main Jul 6, 2026
70 checks passed
@jason810496 jason810496 added this to the Airflow 3.3.0 milestone Jul 6, 2026
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Backport successfully created: v3-3-test

Note: As of Merging PRs targeted for Airflow 3.X
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.

In matter of doubt please ask in #release-management Slack channel.

Status Branch Result
v3-3-test PR Link

github-actions Bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Jul 6, 2026
…DK docs (apache#69433)

* Link the published Java SDK API reference from the Java SDK docs

The interface-based API section pointed readers at the published JavaDoc
without a link, with a TODO left from AIP-108 waiting for the docs site
location to exist. The Javadoc publishing pipeline now targets
https://airflow.apache.org/docs/java-sdk/stable/, so the placeholder can
become a real link, matching how other SDK references are linked.

* Stop calling the published Java SDK API reference Javadoc

The site on airflow.apache.org is an HTML rendering of the API, not an
actual Javadoc rendering; Javadoc is bundled with the released artifacts
instead. The term also fails the docs spell check.
(cherry picked from commit 66798f9)

Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
henry3260 pushed a commit that referenced this pull request Jul 6, 2026
…DK docs (#69433) (#69448)

* Link the published Java SDK API reference from the Java SDK docs

The interface-based API section pointed readers at the published JavaDoc
without a link, with a TODO left from AIP-108 waiting for the docs site
location to exist. The Javadoc publishing pipeline now targets
https://airflow.apache.org/docs/java-sdk/stable/, so the placeholder can
become a real link, matching how other SDK references are linked.

* Stop calling the published Java SDK API reference Javadoc

The site on airflow.apache.org is an HTML rendering of the API, not an
actual Javadoc rendering; Javadoc is bundled with the released artifacts
instead. The term also fails the docs spell check.
(cherry picked from commit 66798f9)

Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
vatsrahul1001 pushed a commit that referenced this pull request Jul 7, 2026
…DK docs (#69433) (#69448)

* Link the published Java SDK API reference from the Java SDK docs

The interface-based API section pointed readers at the published JavaDoc
without a link, with a TODO left from AIP-108 waiting for the docs site
location to exist. The Javadoc publishing pipeline now targets
https://airflow.apache.org/docs/java-sdk/stable/, so the placeholder can
become a real link, matching how other SDK references are linked.

* Stop calling the published Java SDK API reference Javadoc

The site on airflow.apache.org is an HTML rendering of the API, not an
actual Javadoc rendering; Javadoc is bundled with the released artifacts
instead. The term also fails the docs spell check.
(cherry picked from commit 66798f9)

Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
vatsrahul1001 pushed a commit that referenced this pull request Jul 9, 2026
…DK docs (#69433) (#69448)

* Link the published Java SDK API reference from the Java SDK docs

The interface-based API section pointed readers at the published JavaDoc
without a link, with a TODO left from AIP-108 waiting for the docs site
location to exist. The Javadoc publishing pipeline now targets
https://airflow.apache.org/docs/java-sdk/stable/, so the placeholder can
become a real link, matching how other SDK references are linked.

* Stop calling the published Java SDK API reference Javadoc

The site on airflow.apache.org is an HTML rendering of the API, not an
actual Javadoc rendering; Javadoc is bundled with the released artifacts
instead. The term also fails the docs spell check.
(cherry picked from commit 66798f9)

Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AIP-108: java-sdk Change this to an 'area:' label after AIP acceptance. backport-to-v3-3-test Backport to v3-3-test kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants