[GitHub] [kafka] showuon commented on a change in pull request #11175: MINOR: Fix getting started documentation

[GitBox <gi...@apache.org>]

showuon commented on a change in pull request #11175:
URL: https://github.com/apache/kafka/pull/11175#discussion_r683905633



##########
File path: config/kraft/README.md
##########
@@ -26,7 +27,7 @@ xtzWWN4bTjitpL3kfd9s5g
 ~~~~
 
 ## Format Storage Directories
-The next step is to format your storage directories.  If you are running in single-node mode, you can do this with one command:
+The next step is to format your storage directories.  If you are running in single-node mode, you can do this with one command. The string `<uuid>` should be replaced with the value returned by `kafka-storage.sh random-uuid`:
 
 ~~~~
 $ ./bin/kafka-storage.sh format -t <uuid> -c ./config/kraft/server.properties

Review comment:
       How about we put the last sentence as the command line comment. That is:
   
   ~~~~
   # The string `<uuid>` should be replaced with the value returned by `kafka-storage.sh random-uuid`
   
   $ ./bin/kafka-storage.sh format -t <uuid> -c ./config/kraft/server.properties
   Formatting /tmp/kraft-combined-logs
   ~~~~
   




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