You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "joobisb (via GitHub)" <gi...@apache.org> on 2023/06/15 18:23:45 UTC
[GitHub] [kafka] joobisb opened a new pull request, #13862: KAFKA-15050: format the prompts in the quickstart
joobisb opened a new pull request, #13862:
URL: https://github.com/apache/kafka/pull/13862
This patch formats the prompts in quickstart and in kafka streams quickstart
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1245268151
##########
docs/quickstart.html:
##########
@@ -154,9 +154,9 @@ <h4 class="anchor-heading">
By default, each line you enter will result in a separate event being written to the topic.
</p>
- <pre class="line-numbers"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
-This is my first event
-This is my second event</code></pre>
+ <pre class="language-bash"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
+$ This is my first event
+$ This is my second event</code></pre>
Review Comment:
resolved
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #13862: KAFKA-15050: format the prompts in the quickstart
URL: https://github.com/apache/kafka/pull/13862
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "tombentley (via GitHub)" <gi...@apache.org>.
tombentley commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1775906514
@joobisb when I said
> It works fine for me with `<pre><code class="language-bash">`, using both FF and a chrome-based browser.
I meant that I still don't think we need the changes which add the `class="language-bash"` to `<pre>`. Can you remove those?
Sorry for not being clear.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1765072783
@tombentley i've addressed the comments, please have a look
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-2111521992
@tombentley @flavray
I have addressed all the comments, can we merge this ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1603798251
> @mimaison mentioned in a separate conversation a couple of other points:
>
> 1. it looks like we never need to refer to any of the example lines of console input/output using the line numbers, so perhaps we can get rid of the line number for shell command blocks (to it's less visually busy).
> 2. the console producer example is also missing the `>` prompts, maybe we can add them as part of this PR too
@tombentley @mimaison I've addressed the comments, please have a look
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] tombentley commented on pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "tombentley (via GitHub)" <gi...@apache.org>.
tombentley commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1600548439
@mimaison mentioned in a separate conversation a couple of other points:
1. it looks like we never need to refer to any of the example lines of console input/output using the line numbers, so perhaps we can get rid of the line number for shell command blocks (to it's less visually busy).
2. the console producer example is also missing the `>` prompts, maybe we can add them as part of this PR too
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] tombentley commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "tombentley (via GitHub)" <gi...@apache.org>.
tombentley commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1336627061
##########
docs/quickstart.html:
##########
@@ -154,9 +154,9 @@ <h4 class="anchor-heading">
By default, each line you enter will result in a separate event being written to the topic.
</p>
- <pre class="line-numbers"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
-This is my first event
-This is my second event</code></pre>
+ <pre class="language-bash"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
+> This is my first event
+> This is my second event</code></pre>
Review Comment:
The console producer doesn't actually include a space after the `>`.
##########
docs/quickstart.html:
##########
@@ -32,7 +32,7 @@ <h4 class="anchor-heading">
the latest Kafka release and extract it:
</p>
- <pre class="line-numbers"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
+ <pre class="language-bash"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
Review Comment:
It works fine for me with `<pre><code class="language-bash">`, using both FF and a chrome-based browser.
##########
docs/streams/quickstart.html:
##########
@@ -152,8 +150,8 @@ <h4><a id="quickstart_streams_prepare" href="#quickstart_streams_prepare">Step 3
Next, we create the input topic named <b>streams-plaintext-input</b> and the output topic named <b>streams-wordcount-output</b>:
-<pre class="line-numbers"><code class="language-bash">> bin/kafka-topics.sh --create \
- --bootstrap-server localhost:9092 \
+<pre class="language-bash"><code class="language-bash">$ bin/kafka-topics.sh --create \
+--bootstrap-server localhost:9092 \
Review Comment:
We should keep the indentation of this line (as we do for the following continuation lines).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-2614790889
This PR has been closed since it has not had any activity in 120 days. If you feel like this
was a mistake, or you would like to continue working on it, please feel free to re-open the
PR and ask for a review.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1943171155
> @joobisb when I said
>
> > It works fine for me with `\<pre\><code class="language-bash">`, using both FF and a chrome-based browser.
>
> I meant that I still don't think we need the changes which add the `class="language-bash"` to `\<pre\>`. Can you remove those?
>
> Sorry for not being clear.
@tombentley I have removed the `class="language-bash"` from `\<pre\>`. Could you please take a look
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1245057900
##########
docs/quickstart.html:
##########
@@ -32,7 +32,7 @@ <h4 class="anchor-heading">
the latest Kafka release and extract it:
</p>
- <pre class="line-numbers"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
+ <pre class="language-bash"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
Review Comment:
<img width="684" alt="image" src="https://github.com/apache/kafka/assets/13068144/e4285029-5a1c-4002-8ed6-f8a95c97e2a0">
If I remove the `language-bash` class from `<pre>` it will lose the associated properties as shown in the first image above
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1595663538
@tombentley have addressed the comments, please have a look
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] tombentley commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "tombentley (via GitHub)" <gi...@apache.org>.
tombentley commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1232343003
##########
docs/streams/quickstart.html:
##########
@@ -91,8 +91,8 @@ <h4><a id="quickstart_streams_download" href="#quickstart_streams_download">Step
<a href="https://www.apache.org/dyn/closer.cgi?path=/kafka/{{fullDotVersion}}/kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz" title="Kafka downloads">Download</a> the {{fullDotVersion}} release and un-tar it.
Note that there are multiple downloadable Scala versions and we choose to use the recommended version ({{scalaVersion}}) here:
-<pre class="line-numbers"><code class="language-bash">> tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
-> cd kafka_{{scalaVersion}}-{{fullDotVersion}}</code></pre>
+ <pre class="line-numbers"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
Review Comment:
Do we need the initial two spaces?
##########
docs/quickstart.html:
##########
@@ -215,19 +215,17 @@ <h4 class="anchor-heading">
Edit the <code class="language-bash">config/connect-standalone.properties</code> file, add or change the <code>plugin.path</code> configuration property match the following, and save the file:
</p>
- <pre class="brush: bash;">
-> echo "plugin.path=libs/connect-file-{{fullDotVersion}}.jar"</pre>
+ <pre class="line-numbers"><code class="language-bash">$ echo "plugin.path=libs/connect-file-{{fullDotVersion}}.jar"</code></pre>
Review Comment:
```suggestion
<pre class="line-numbers"><code class="language-bash">$ echo "plugin.path=libs/connect-file-{{fullDotVersion}}.jar" >> config/connect-standalone.properties</code></pre>
```
##########
docs/quickstart.html:
##########
@@ -215,19 +215,17 @@ <h4 class="anchor-heading">
Edit the <code class="language-bash">config/connect-standalone.properties</code> file, add or change the <code>plugin.path</code> configuration property match the following, and save the file:
Review Comment:
We don't actually mean it "should match the following" if _the following_ is some bash commands.
```suggestion
Edit the <code class="language-bash">config/connect-standalone.properties</code> file, adding or changing the <code>plugin.path</code> configuration property to include <code>libs/connect-file-{{fullDotVersion}}.jar</code> and save the file. Alternatively, in your terminal session you can use the following command:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1245058126
##########
docs/quickstart.html:
##########
@@ -154,9 +154,9 @@ <h4 class="anchor-heading">
By default, each line you enter will result in a separate event being written to the topic.
</p>
- <pre class="line-numbers"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
-This is my first event
-This is my second event</code></pre>
+ <pre class="language-bash"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
+$ This is my first event
+$ This is my second event</code></pre>
Review Comment:
will update these
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] tombentley commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "tombentley (via GitHub)" <gi...@apache.org>.
tombentley commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1243442987
##########
docs/quickstart.html:
##########
@@ -154,9 +154,9 @@ <h4 class="anchor-heading">
By default, each line you enter will result in a separate event being written to the topic.
</p>
- <pre class="line-numbers"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
-This is my first event
-This is my second event</code></pre>
+ <pre class="language-bash"><code class="language-bash">$ bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
+$ This is my first event
+$ This is my second event</code></pre>
Review Comment:
`kafka-console-producer.sh` has its own prompt using a `>` character and without a space.
```suggestion
>This is my first event
>This is my second event</code></pre>
```
##########
docs/quickstart.html:
##########
@@ -32,7 +32,7 @@ <h4 class="anchor-heading">
the latest Kafka release and extract it:
</p>
- <pre class="line-numbers"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
+ <pre class="language-bash"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
Review Comment:
The `<code>` already has `class="language-bash"`, so I don't think we need it on the `<pre>` as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-15050: format the prompts in the quickstart [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-2563280311
This PR is being marked as stale since it has not had any activity in 90 days. If you
would like to keep this PR alive, please leave a comment asking for a review. If the PR has
merge conflicts, update it with the latest from the base branch.
<p>
If you are having difficulty finding a reviewer, please reach out on the
[mailing list](https://kafka.apache.org/contact).
<p>
If this PR is no longer valid or desired, please feel free to close it. If no activity
occurs in the next 30 days, it will be automatically closed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1232988532
##########
docs/streams/quickstart.html:
##########
@@ -91,8 +91,8 @@ <h4><a id="quickstart_streams_download" href="#quickstart_streams_download">Step
<a href="https://www.apache.org/dyn/closer.cgi?path=/kafka/{{fullDotVersion}}/kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz" title="Kafka downloads">Download</a> the {{fullDotVersion}} release and un-tar it.
Note that there are multiple downloadable Scala versions and we choose to use the recommended version ({{scalaVersion}}) here:
-<pre class="line-numbers"><code class="language-bash">> tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
-> cd kafka_{{scalaVersion}}-{{fullDotVersion}}</code></pre>
+ <pre class="line-numbers"><code class="language-bash">$ tar -xzf kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
Review Comment:
right will remove those
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joobisb commented on pull request #13862: KAFKA-15050: format the prompts in the quickstart
Posted by "joobisb (via GitHub)" <gi...@apache.org>.
joobisb commented on PR #13862:
URL: https://github.com/apache/kafka/pull/13862#issuecomment-1624188820
@tombentley could you please have a look, have addressed the comments
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org