Good question. I couldn't find anything about it except for 9ef6796e [1]
where it was excluded from the Maven deployment. Unfortunately, no Jira
issue is attached with additional documentation.

@Martijn Visser <martijnvis...@apache.org> How is the docs generation
intended to be used? It looks like it's done by integrating the connector
docs as git submodules which then makes sure that the connector-specific
config option documentation is generated along the Flink docs.

@tison What's the scenario in which you want to use the generation logic?

Matthias

[1] https://github.com/apache/flink/commit/9ef6796e

On Tue, Oct 17, 2023 at 8:26 AM tison <wander4...@gmail.com> wrote:

> Hi,
>
> During the development of flink-connector-pulsar, I found a requirement to
> generate config docs like the main repo does[1]:
>
>     mvn -Pgenerate-config-docs install -Dfast -DskipTests
>
> However, it's not preset for external connector repo. So I make the
> generate-config-docs myself, and encountered the next issue:
>
>     [java] Error: Could not find or load main class
> org.apache.flink.docs.configuration.ConfigOptionsDocGenerator
>
> Of course, I should add flink-docs as a dependency for the execution. But
> it seems that flink-docs is not released to Maven central and thus I cannot
> depend on it.
>
> Do you have ideas on this topic? Or how do you generate config docs for
> external connectors?
>
> Best,
> tison.
>
> [1]
>
> https://github.com/apache/flink/tree/master/docs#generate-configuration-tables
>

Reply via email to