[GitHub] [kafka] tombentley commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart

2023-09-25 Thread via GitHub


tombentley commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1336627061


##
docs/quickstart.html:
##
@@ -154,9 +154,9 @@ 
 By default, each line you enter will result in a separate event 
being written to the topic.
 
 
-$ 
bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server 
localhost:9092
-This is my first event
-This is my second event
+$ 
bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server 
localhost:9092
+> This is my first event
+> This is my second event

Review Comment:
   The console producer doesn't actually include a space after the `>`.



##
docs/quickstart.html:
##
@@ -32,7 +32,7 @@ 
 the latest Kafka release and extract it:
 
 
-$ tar -xzf 
kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
+$ tar -xzf 
kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz

Review Comment:
   It works fine for me with ``, using both FF 
and a chrome-based browser. 



##
docs/streams/quickstart.html:
##
@@ -152,8 +150,8 @@ Step 3
 
 Next, we create the input topic named streams-plaintext-input and the 
output topic named streams-wordcount-output:
 
- bin/kafka-topics.sh 
--create \
---bootstrap-server localhost:9092 \
+$ 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-unsubscr...@kafka.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [kafka] tombentley commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart

2023-06-27 Thread via GitHub


tombentley commented on code in PR #13862:
URL: https://github.com/apache/kafka/pull/13862#discussion_r1243442987


##
docs/quickstart.html:
##
@@ -154,9 +154,9 @@ 
 By default, each line you enter will result in a separate event 
being written to the topic.
 
 
-$ 
bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server 
localhost:9092
-This is my first event
-This is my second event
+$ 
bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server 
localhost:9092
+$ This is my first event
+$ This is my second event

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
   ```



##
docs/quickstart.html:
##
@@ -32,7 +32,7 @@ 
 the latest Kafka release and extract it:
 
 
-$ tar -xzf 
kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
+$ tar -xzf 
kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz

Review Comment:
   The `` already has `class="language-bash"`, so I don't think we need 
it on the `` 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-unsubscr...@kafka.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [kafka] tombentley commented on a diff in pull request #13862: KAFKA-15050: format the prompts in the quickstart

2023-06-16 Thread via GitHub


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 @@ Step
 https://www.apache.org/dyn/closer.cgi?path=/kafka/{{fullDotVersion}}/kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz;
 title="Kafka downloads">Download 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:
 
- tar -xzf 
kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz
- cd kafka_{{scalaVersion}}-{{fullDotVersion}}
+  $ tar -xzf 
kafka_{{scalaVersion}}-{{fullDotVersion}}.tgz

Review Comment:
   Do we need the initial two spaces?



##
docs/quickstart.html:
##
@@ -215,19 +215,17 @@ 
 Edit the config/connect-standalone.properties file, add or 
change the plugin.path configuration property match the following, 
and save the file:
 
 
-
- echo "plugin.path=libs/connect-file-{{fullDotVersion}}.jar"
+$ echo 
"plugin.path=libs/connect-file-{{fullDotVersion}}.jar"

Review Comment:
   ```suggestion
   $ echo 
"plugin.path=libs/connect-file-{{fullDotVersion}}.jar" >> 
config/connect-standalone.properties
   ```



##
docs/quickstart.html:
##
@@ -215,19 +215,17 @@ 
 Edit the config/connect-standalone.properties file, add or 
change the plugin.path 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 config/connect-standalone.properties file, adding 
or changing the plugin.path configuration property to include 
libs/connect-file-{{fullDotVersion}}.jar 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-unsubscr...@kafka.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org