flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ches...@apache.org
Subject [1/3] flink git commit: [hotfix][docs] Update maven instructions for generating docs
Date Wed, 04 Apr 2018 14:12:53 GMT
Repository: flink
Updated Branches:
  refs/heads/release-1.5 85af3a286 -> 69b9515b4


[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/ba189623
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/ba189623
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/ba189623

Branch: refs/heads/release-1.5
Commit: ba189623035f1048a85c6eab3e16c20a3f7f0845
Parents: 85af3a2
Author: zentol <chesnay@apache.org>
Authored: Wed Apr 4 16:05:58 2018 +0200
Committer: zentol <chesnay@apache.org>
Committed: Wed Apr 4 16:12:38 2018 +0200

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


http://git-wip-us.apache.org/repos/asf/flink/blob/ba189623/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


Mime
View raw message