This is an automated email from the ASF dual-hosted git repository.
zhuzh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 8fe005cf132 [FLINK-33241][doc] Align config option generation
documentation for Flink's config documentation.
8fe005cf132 is described below
commit 8fe005cf1325b7477d7e1808a46bd80798165029
Author: JunRuiLee <[email protected]>
AuthorDate: Tue Feb 20 12:14:43 2024 +0800
[FLINK-33241][doc] Align config option generation documentation for Flink's
config documentation.
---
docs/README.md | 13 ++-----------
1 file changed, 2 insertions(+), 11 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index bc59ea579eb..025dcdb0a75 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -56,18 +56,9 @@ Replace <connector_name> with the name of your connector,
e.g., `elasticsearch`
## Generate configuration tables
-Configuration descriptions are auto generated from code. To trigger the
generation you need to run in the project root:
+Configuration descriptions are auto generated from code. To trigger the
generation, you need to run a command in the project root (see [Configuration
documentation](https://github.com/apache/flink/blob/master/flink-docs/README.md#configuration-documentation).)
-```
-mvn -Pgenerate-config-docs install -Dfast -DskipTests
-```
-
-The resulting html files will be written to `layouts/shortcodes/generated`.
Tables are regenerated each time the command is invoked.
-These tables can be directly included into the documentation:
-
-```
-{{< generated/file_name >}}
-```
+The resulting html files will be written to `layouts/shortcodes/generated`.
# Contribute
