[
https://issues.apache.org/jira/browse/FLINK-39960?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
ASF GitHub Bot updated FLINK-39960:
-----------------------------------
Labels: pull-request-available (was: )
> Remove broken JavaDoc shortcode usage from JDBC datastream docs
> ---------------------------------------------------------------
>
> Key: FLINK-39960
> URL: https://issues.apache.org/jira/browse/FLINK-39960
> Project: Flink
> Issue Type: Improvement
> Components: Connectors / JDBC
> Affects Versions: jdbc-4.0.0
> Reporter: Dennis-Mircea Ciupitu
> Priority: Major
> Labels: pull-request-available
>
> h1. Description
> The JDBC DataStream connector documentation uses the {{javadoc}} Hugo
> shortcode
> {noformat}
> {{< javadoc ... >}}
> {noformat}
> to link to connector classes such as {{{}JdbcSource{}}}, {{{}JdbcSink{}}},
> {{{}JdbcSourceBuilder{}}}, {{{}JdbcParameterValuesProvider{}}},
> {{{}ContinuousUnBoundingSettings{}}}, {{{}JdbcExecutionOptions{}}},
> {{JdbcConnectionOptions}} and {{{}JdbcExactlyOnceOptions{}}}.
> This shortcode resolves to the core Flink JavaDoc base URL
> ({{{}//nightlies.apache.org/flink/flink-docs-master/api/java/{}}}), where
> these externalized connector classes are not published. ASF nightlies also
> does not host a standalone JavaDoc site for the JDBC connector. As a result,
> every JavaDoc link on the JDBC DataStream page currently returns a 404.
> h1. Fix
> Replace each {{javadoc}} shortcode invocation with a backticked class name
> (or drop the dangling "see also" sentence where the surrounding text already
> names the class), matching the convention already used in the Kafka,
> Elasticsearch and Pulsar connector docs.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
