You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Matthias Pohl (Jira)" <ji...@apache.org> on 2023/10/11 12:10:00 UTC
[jira] [Updated] (FLINK-33241) Align config option generation documentation for Flink's config documentation
[ https://issues.apache.org/jira/browse/FLINK-33241?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Matthias Pohl updated FLINK-33241:
----------------------------------
Description:
The configuration parameter docs generation is documented in two places in different ways:
[docs/README.md:62|https://github.com/apache/flink/blob/5c1e9f3b1449cb77276d578b344d9a69c7cf9a3c/docs/README.md#L62] and [flink-docs/README.md:44|https://github.com/apache/flink/blob/7bebd2d9fac517c28afc24c0c034d77cfe2b43a6/flink-docs/README.md#L44].
We should remove the corresponding command from {{docs/README.md}} and refer to {{flink-docs/README.md}} for the documentation. That way, we only have to maintain a single file.
was:
The configuration parameter docs generation is documented in two places in different ways:
[docs/README.md:62|https://github.com/apache/flink/blob/5c1e9f3b1449cb77276d578b344d9a69c7cf9a3c/docs/README.md#L62] and [flink-docs/README.md:44|https://github.com/apache/flink/blob/7bebd2d9fac517c28afc24c0c034d77cfe2b43a6/flink-docs/README.md#L44]. Only the latter one works.
We should remove the corresponding command from {{docs/README.md}} and refer to {{flink-docs/README.md}} for the documentation. That way, we only have to maintain a single file.
> Align config option generation documentation for Flink's config documentation
> -----------------------------------------------------------------------------
>
> Key: FLINK-33241
> URL: https://issues.apache.org/jira/browse/FLINK-33241
> Project: Flink
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.19.0
> Reporter: Matthias Pohl
> Priority: Major
>
> The configuration parameter docs generation is documented in two places in different ways:
> [docs/README.md:62|https://github.com/apache/flink/blob/5c1e9f3b1449cb77276d578b344d9a69c7cf9a3c/docs/README.md#L62] and [flink-docs/README.md:44|https://github.com/apache/flink/blob/7bebd2d9fac517c28afc24c0c034d77cfe2b43a6/flink-docs/README.md#L44].
> We should remove the corresponding command from {{docs/README.md}} and refer to {{flink-docs/README.md}} for the documentation. That way, we only have to maintain a single file.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)