From c574c58a16147d2d4997145bc47b0ba558d68a36 Mon Sep 17 00:00:00 2001 From: Ismael Juma Date: Fri, 7 Jul 2017 14:41:54 +0100 Subject: [PATCH] MINOR: Improve versioning in docs when a full version is required Also fix quickstart. Author: Ismael Juma Reviewers: Damian Guy Closes #3501 from ijuma/introduce-full-version-variable-in-docs --- docs/api.html | 8 ++++---- docs/js/templateData.js | 5 +++-- docs/quickstart.html | 8 ++++---- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/api.html b/docs/api.html index 05768a1bc4b..97771861883 100644 --- a/docs/api.html +++ b/docs/api.html @@ -39,7 +39,7 @@ <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> - <version>{{dotVersion}}.0</version> + <version>{{fullDotVersion}}</version> </dependency> @@ -55,7 +55,7 @@ <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> - <version>{{dotVersion}}.0</version> + <version>{{fullDotVersion}}</version> </dependency> @@ -74,7 +74,7 @@ <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-streams</artifactId> - <version>{{dotVersion}}.0</version> + <version>{{fullDotVersion}}</version> </dependency> @@ -96,7 +96,7 @@ <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> - <version>{{dotVersion}}.0</version> + <version>{{fullDotVersion}}</version> </dependency> For more information about the AdminClient APIs, see the javadoc. diff --git a/docs/js/templateData.js b/docs/js/templateData.js index 2f32444d5d9..3eca71ede69 100644 --- a/docs/js/templateData.js +++ b/docs/js/templateData.js @@ -18,5 +18,6 @@ limitations under the License. // Define variables for doc templates var context={ "version": "0110", - "dotVersion": "0.11.0" -}; \ No newline at end of file + "dotVersion": "0.11.0", + "fullDotVersion": "0.11.0.0" +}; diff --git a/docs/quickstart.html b/docs/quickstart.html index 6509f75bed5..40aa2fbe1b4 100644 --- a/docs/quickstart.html +++ b/docs/quickstart.html @@ -25,11 +25,11 @@ Since Kafka console scripts are different for Unix-based and Windows platforms,

Step 1: Download the code

-Download the 0.10.2.0 release and un-tar it. +Download the {{fullDotVersion}} release and un-tar it. 
-> tar -xzf kafka_2.11-0.10.2.0.tgz
-> cd kafka_2.11-0.10.2.0
+> tar -xzf kafka_2.11-{{fullDotVersion}}.tgz
+> cd kafka_2.11-{{fullDotVersion}}

Step 2: Start the server

@@ -187,7 +187,7 @@ my test message 2 On Windows use: 
 > wmic process get processid,caption,commandline | find "java.exe" | find "server-1.properties"
-java.exe    java  -Xmx1G -Xms1G -server -XX:+UseG1GC ... build\libs\kafka_2.11-0.10.2.0.jar"  kafka.Kafka config\server-1.properties    644
+java.exe    java  -Xmx1G -Xms1G -server -XX:+UseG1GC ... build\libs\kafka_2.11-{{fullDotVersion}}.jar"  kafka.Kafka config\server-1.properties    644
 > taskkill /pid 644 /f