This is an automated email from the ASF dual-hosted git repository.
fanrui pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 0f140433 [hotfix][docs] Add the -am when generate the docs
0f140433 is described below
commit 0f1404333ed1ff2e49d495e474ed7acbc4054e12
Author: Rui Fan <[email protected]>
AuthorDate: Thu Jan 4 15:10:40 2024 +0800
[hotfix][docs] Add the -am when generate the docs
-am is required when the local repository is not up to date. If generate
doc without -am, the generated doc may be wrong.
---
flink-kubernetes-docs/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/flink-kubernetes-docs/README.md b/flink-kubernetes-docs/README.md
index 9a04abb6..2f2177e3 100644
--- a/flink-kubernetes-docs/README.md
+++ b/flink-kubernetes-docs/README.md
@@ -27,7 +27,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 `ConfigOptionsDocGenerator#LOCATIONS`.
-The files can be generated by running `mvn package -Pgenerate-docs -pl
flink-kubernetes-docs -nsu -DskipTests`, and can be integrated into the
documentation using `{{ include generated/<file-name> >}}`.
+The files can be generated by running `mvn package -Pgenerate-docs -pl
flink-kubernetes-docs -am -nsu -DskipTests`, 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
