This is an automated email from the ASF dual-hosted git repository. lzljs3620320 pushed a commit to branch release-0.4 in repository https://gitbox.apache.org/repos/asf/incubator-paimon.git
commit 87940d4e58151e88f62af245f0d95a11143e7f4b Author: zhangmang <[email protected]> AuthorDate: Wed Apr 26 16:20:50 2023 +0800 [hotfix][docs] Add tips for using the generate-docs maven plugin (#1033) --- paimon-docs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/paimon-docs/README.md b/paimon-docs/README.md index b6fa96fb9..4769275d4 100644 --- a/paimon-docs/README.md +++ b/paimon-docs/README.md @@ -30,6 +30,8 @@ To integrate an `*Options` class from another package, add another module-packag The files can be generated by running `mvn package -Pgenerate-docs -pl paimon-docs -nsu -DskipTests`, and can be integrated into the documentation using `{{ include generated/<file-name> >}}`. +**NOTE:** You need to make sure that the changed jar has been installed to the local maven repository. + The documentation must be regenerated whenever * an `*Options` class was added or removed * a `ConfigOption` was added to or removed from an `*Options` class
