flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From trohrm...@apache.org
Subject [flink] 03/03: [hotfix][docs] Add -DskipTests flag to command that generates docs.
Date Tue, 31 Jul 2018 12:27:20 GMT
This is an automated email from the ASF dual-hosted git repository.

trohrmann pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit e1ca4c46ea7e2940b0200b635bc49766d594ffb0
Author: gyao <gary@data-artisans.com>
AuthorDate: Tue Jul 24 15:55:16 2018 +0200

    [hotfix][docs] Add -DskipTests flag to command that generates docs.
---
 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 61624fa..0a57428 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 -pl flink-docs
-am -nsu`
+3. Regenerate the documentation by running `mvn package -Dgenerate-rest-docs -pl flink-docs
-am -nsu -DskipTests`
 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 `ConfigOptionsDocGenerator#LOCATIONS`.
 
-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 files can be generated by running `mvn package -Dgenerate-config-docs -pl flink-docs
-am -nsu -DskipTests`, 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


Mime
View raw message