Skip to content

Commit

Permalink
[FLINK-33241][doc] Align config option generation documentation for F…
Browse files Browse the repository at this point in the history
…link's config documentation.
  • Loading branch information
JunRuiLee authored and zhuzhurk committed Feb 20, 2024
1 parent 049de66 commit 8fe005c
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 8fe005c

Please sign in to comment.