kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ij...@apache.org
Subject kafka git commit: MINOR: Improve versioning in docs when a full version is required
Date Fri, 07 Jul 2017 13:41:59 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 071b8f975 -> c574c58a1


MINOR: Improve versioning in docs when a full version is required

Also fix quickstart.

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Damian Guy <damian.guy@gmail.com>

Closes #3501 from ijuma/introduce-full-version-variable-in-docs


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

Branch: refs/heads/trunk
Commit: c574c58a16147d2d4997145bc47b0ba558d68a36
Parents: 071b8f9
Author: Ismael Juma <ismael@juma.me.uk>
Authored: Fri Jul 7 14:41:54 2017 +0100
Committer: Ismael Juma <ismael@juma.me.uk>
Committed: Fri Jul 7 14:41:54 2017 +0100

----------------------------------------------------------------------
 docs/api.html           | 8 ++++----
 docs/js/templateData.js | 5 +++--
 docs/quickstart.html    | 8 ++++----
 3 files changed, 11 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/c574c58a/docs/api.html
----------------------------------------------------------------------
diff --git a/docs/api.html b/docs/api.html
index 05768a1..9777186 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -39,7 +39,7 @@
 		&lt;dependency&gt;
 			&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
 			&lt;artifactId&gt;kafka-clients&lt;/artifactId&gt;
-			&lt;version&gt;{{dotVersion}}.0&lt;/version&gt;
+			&lt;version&gt;{{fullDotVersion}}&lt;/version&gt;
 		&lt;/dependency&gt;
 	</pre>
 
@@ -55,7 +55,7 @@
 		&lt;dependency&gt;
 			&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
 			&lt;artifactId&gt;kafka-clients&lt;/artifactId&gt;
-			&lt;version&gt;{{dotVersion}}.0&lt;/version&gt;
+			&lt;version&gt;{{fullDotVersion}}&lt;/version&gt;
 		&lt;/dependency&gt;
 	</pre>
 
@@ -74,7 +74,7 @@
 		&lt;dependency&gt;
 			&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
 			&lt;artifactId&gt;kafka-streams&lt;/artifactId&gt;
-			&lt;version&gt;{{dotVersion}}.0&lt;/version&gt;
+			&lt;version&gt;{{fullDotVersion}}&lt;/version&gt;
 		&lt;/dependency&gt;
 	</pre>
 
@@ -96,7 +96,7 @@
 		&lt;dependency&gt;
 			&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
 			&lt;artifactId&gt;kafka-clients&lt;/artifactId&gt;
-			&lt;version&gt;{{dotVersion}}.0&lt;/version&gt;
+			&lt;version&gt;{{fullDotVersion}}&lt;/version&gt;
 		&lt;/dependency&gt;
 	</pre>
 	For more information about the AdminClient APIs, see the <a href="/{{version}}/javadoc/index.html?org/apache/kafka/clients/admin/AdminClient.html"
title="Kafka {{dotVersion}} Javadoc">javadoc</a>.

http://git-wip-us.apache.org/repos/asf/kafka/blob/c574c58a/docs/js/templateData.js
----------------------------------------------------------------------
diff --git a/docs/js/templateData.js b/docs/js/templateData.js
index 2f32444..3eca71e 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"
+};

http://git-wip-us.apache.org/repos/asf/kafka/blob/c574c58a/docs/quickstart.html
----------------------------------------------------------------------
diff --git a/docs/quickstart.html b/docs/quickstart.html
index 6509f75..40aa2fb 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,
 
 <h4><a id="quickstart_download" href="#quickstart_download">Step 1: Download
the code</a></h4>
 
-<a href="https://www.apache.org/dyn/closer.cgi?path=/kafka/0.10.2.0/kafka_2.11-0.10.2.0.tgz"
title="Kafka downloads">Download</a> the 0.10.2.0 release and un-tar it.
+<a href="https://www.apache.org/dyn/closer.cgi?path=/kafka/{{fullDotVersion}}/kafka_2.11-{{fullDotVersion}}.tgz"
title="Kafka downloads">Download</a> the {{fullDotVersion}} release and un-tar it.
 
 <pre class="brush: bash;">
-&gt; tar -xzf kafka_2.11-0.10.2.0.tgz
-&gt; cd kafka_2.11-0.10.2.0
+&gt; tar -xzf kafka_2.11-{{fullDotVersion}}.tgz
+&gt; cd kafka_2.11-{{fullDotVersion}}
 </pre>
 
 <h4><a id="quickstart_startserver" href="#quickstart_startserver">Step 2: Start
the server</a></h4>
@@ -187,7 +187,7 @@ my test message 2
 On Windows use:
 <pre class="brush: bash;">
 &gt; 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
 &gt; taskkill /pid 644 /f
 </pre>
 


Mime
View raw message