[hotfix][docs] Update maven instructions for generating docs

Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/88efdd13
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/88efdd13
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/88efdd13

Branch: refs/heads/master
Commit: 88efdd13622d0e334b263791cfc7bc8bdf96449e
Parents: 77c306b
Author: zentol <ches...@apache.org>
Authored: Wed Apr 4 16:05:58 2018 +0200
Committer: zentol <ches...@apache.org>
Committed: Wed Apr 4 16:11:57 2018 +0200

----------------------------------------------------------------------
 flink-docs/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/88efdd13/flink-docs/README.md
----------------------------------------------------------------------
diff --git a/flink-docs/README.md b/flink-docs/README.md
index b6de6f1..bad5444 100644
--- a/flink-docs/README.md
+++ b/flink-docs/README.md
@@ -28,7 +28,7 @@ The `RestAPIDocGenerator` can be used to generate a full 
reference of the REST A
 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 
-nsu`
+3. Regenerate the documentation by running `mvn package -Dgenerate-rest-docs 
-pl flink-docs -am -nsu`
 4. Integrate the generated file into the REST API documentation by adding `{% 
include generated/<file-name>.html %}` to the corresponding markdown file.
 
 The documentation must be regenerated whenever
@@ -41,7 +41,7 @@ The `ConfigOptionsDocGenerator` can be use to generate a 
reference of `ConfigOpt
 
 To integrate an `*Options` class from another package, add another 
module-package argument pair to the `maven-antrun-plugin` configuration in the 
`generate-config-docs` profile.
 
-The files can be generated by running `mvn package -Dgenerate-config-docs`, 
and can be integrated into the documentation using `{% include 
generated/<file-name>.html %}`.
+The files can be generated by running `mvn package -Dgenerate-config-docs -pl 
flink-docs -am -nsu`, and can be integrated into the documentation using `{% 
include generated/<file-name>.html %}`.
 
 The documentation must be regenerated whenever
 * an `*Options` class was added or removed

Reply via email to