Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


mimaison merged PR #16375:
URL: https://github.com/apache/kafka/pull/16375


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



Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


mimaison commented on PR #16375:
URL: https://github.com/apache/kafka/pull/16375#issuecomment-2176341868

   Since all changes are to `.html` files, I'll not wait for tests to complete. 
Merging to trunk.


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



Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


mimaison commented on code in PR #16375:
URL: https://github.com/apache/kafka/pull/16375#discussion_r1644600311


##
docs/streams/developer-guide/app-reset-tool.html:
##
@@ -78,9 +78,9 @@
 Step 1: Run the application reset tool
 Invoke the application reset tool from the command line
 Warning! This tool makes irreversible changes to your 
application. It is strongly recommended that you run this once with --dry-run to preview 
your changes before making them.
-path-to-kafka/bin/kafka-streams-application-reset
+$ 
bin/kafka-streams-application-reset

Review Comment:
   Fixed



##
docs/implementation.html:
##
@@ -75,13 +75,13 @@ 5.3.1.1 Control Batches
 A control batch contains a single record called the control record. 
Control records should not be passed on to applications. Instead, they are used 
by consumers to filter out aborted transactional messages.
  The key of a control record conforms to the following schema: 
-version: int16 
(current version is 0)
+version: int16 (current version is 0)
 type: int16 (0 indicates an abort marker, 1 indicates a commit)
 The schema for the value of a control record is dependent on the type. 
The value is opaque to clients.
 
 5.3.2 Record
Record level headers were introduced in Kafka 0.11.0. The on-disk 
format of a record with Headers is delineated below. 
-   length: varint
+   length: varint

Review Comment:
   Fixed



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



Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


chia7712 commented on code in PR #16375:
URL: https://github.com/apache/kafka/pull/16375#discussion_r1644574034


##
docs/streams/developer-guide/app-reset-tool.html:
##
@@ -78,9 +78,9 @@
 Step 1: Run the application reset tool
 Invoke the application reset tool from the command line
 Warning! This tool makes irreversible changes to your 
application. It is strongly recommended that you run this once with --dry-run to preview 
your changes before making them.
-path-to-kafka/bin/kafka-streams-application-reset
+$ 
bin/kafka-streams-application-reset

Review Comment:
   ` `5.3.1.1 Control Batches
 A control batch contains a single record called the control record. 
Control records should not be passed on to applications. Instead, they are used 
by consumers to filter out aborted transactional messages.
  The key of a control record conforms to the following schema: 
-version: int16 
(current version is 0)
+version: int16 (current version is 0)
 type: int16 (0 indicates an abort marker, 1 indicates a commit)
 The schema for the value of a control record is dependent on the type. 
The value is opaque to clients.
 
 5.3.2 Record
Record level headers were introduced in Kafka 0.11.0. The on-disk 
format of a record with Headers is delineated below. 
-   length: varint
+   length: varint

Review Comment:
   `` -> ``



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



Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


showuon commented on PR #16375:
URL: https://github.com/apache/kafka/pull/16375#issuecomment-2175941712

   > If it's a pain to review, I can split the PR.
   
   It's fine. It looks good. Thanks.


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



Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


mimaison commented on PR #16375:
URL: https://github.com/apache/kafka/pull/16375#issuecomment-2175856402

   If it's a pain to review, I can split the PR. 


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



Re: [PR] MINOR: Refresh of the docs [kafka]

2024-06-18 Thread via GitHub


mimaison commented on PR #16375:
URL: https://github.com/apache/kafka/pull/16375#issuecomment-2175737130

   It's not easy since this includes changes all over the website. Like for 
code changes, reviewers should test this change locally. 


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