This is an automated email from the ASF dual-hosted git repository. snuyanzin pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
commit af86700bbc67eab888553a73dd6b185e5f43d459 Author: Sergey Nuyanzin <[email protected]> AuthorDate: Thu Nov 6 16:08:32 2025 +0100 [hotfix][docs] Use `mvnw` in flink-docs README --- flink-docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/flink-docs/README.md b/flink-docs/README.md index e71a3b492a2..827fde9ef3f 100644 --- a/flink-docs/README.md +++ b/flink-docs/README.md @@ -28,7 +28,7 @@ The `RestAPIDocGenerator`/`OpenApiSpecGenerator` can be used to generate a full To integrate a new endpoint into the generator 1. Add a new `DocumentingRestEndpoint` class to `RestAPIDocGenerator` that extends the new endpoint class 2. Add another call to `createHtmlFile` in `RestAPIDocGenerator#main` -3. Regenerate the documentation by running `mvn package -Dgenerate-rest-docs -pl flink-docs -am -nsu -DskipTests` +3. Regenerate the documentation by running `./mvnw package -Dgenerate-rest-docs -pl flink-docs -am -nsu -DskipTests` 4. Integrate the generated file into the REST API documentation by adding `{{< generated/<file-name> }}` to the corresponding markdown file. The documentation must be regenerated whenever @@ -41,7 +41,7 @@ The `ConfigOptionsDocGenerator` can be used to generate a reference of `ConfigOp To integrate an `*Options` class from another package, add another module-package argument pair to `ConfigurationOptionLocator#LOCATIONS`. -The files can be generated by running `mvn package -Dgenerate-config-docs -pl flink-docs -am -nsu -DskipTests -Pskip-webui-build`, and can be integrated into the documentation using `{{ include generated/<file-name> >}}`. +The files can be generated by running `./mvnw package -Dgenerate-config-docs -pl flink-docs -am -nsu -DskipTests -Pskip-webui-build`, and can be integrated into the documentation using `{{ include generated/<file-name> >}}`. The documentation must be regenerated whenever * an `*Options` class was added or removed
