root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

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
This commit is contained in:
Ismael Juma 2017-07-07 14:41:54 +01:00
parent 071b8f975f
commit c574c58a16
3 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.html
View File

@ -39,7 +39,7 @@
&lt;dependency&gt; &lt;dependency&gt;
&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt; &lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
&lt;artifactId&gt;kafka-clients&lt;/artifactId&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; &lt;/dependency&gt;
</pre> </pre>
@ -55,7 +55,7 @@
&lt;dependency&gt; &lt;dependency&gt;
&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt; &lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
&lt;artifactId&gt;kafka-clients&lt;/artifactId&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; &lt;/dependency&gt;
</pre> </pre>
@ -74,7 +74,7 @@
&lt;dependency&gt; &lt;dependency&gt;
&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt; &lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
&lt;artifactId&gt;kafka-streams&lt;/artifactId&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; &lt;/dependency&gt;
</pre> </pre>
@ -96,7 +96,7 @@
&lt;dependency&gt; &lt;dependency&gt;
&lt;groupId&gt;org.apache.kafka&lt;/groupId&gt; &lt;groupId&gt;org.apache.kafka&lt;/groupId&gt;
&lt;artifactId&gt;kafka-clients&lt;/artifactId&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; &lt;/dependency&gt;
</pre> </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>. 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>.

5
docs/js/templateData.js
View File

@ -18,5 +18,6 @@ limitations under the License.
// Define variables for doc templates // Define variables for doc templates
var context={ var context={
"version": "0110", "version": "0110",
"dotVersion": "0.11.0" "dotVersion": "0.11.0",
}; "fullDotVersion": "0.11.0.0"
};

8
docs/quickstart.html
View File

@ -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> <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;"> <pre class="brush: bash;">
&gt; tar -xzf kafka_2.11-0.10.2.0.tgz &gt; tar -xzf kafka_2.11-{{fullDotVersion}}.tgz
&gt; cd kafka_2.11-0.10.2.0 &gt; cd kafka_2.11-{{fullDotVersion}}
</pre> </pre>
<h4><a id="quickstart_startserver" href="#quickstart_startserver">Step 2: Start the server</a></h4> <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: On Windows use:
<pre class="brush: bash;"> <pre class="brush: bash;">
&gt; wmic process get processid,caption,commandline | find "java.exe" | find "server-1.properties" &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 &gt; taskkill /pid 644 /f
</pre> </pre>