You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "mimaison (via GitHub)" <gi...@apache.org> on 2023/12/04 15:17:10 UTC
[PR] MINOR: Various fixes in the docs [kafka]
mimaison opened a new pull request, #14914:
URL: https://github.com/apache/kafka/pull/14914
- Only use https links
- Fix broken HTML tags
- Replace usage of <tt> which is deprecated with <code>
- Replace hardcoded version numbers
### 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
Re: [PR] MINOR: Various fixes in the docs [kafka]
Posted by "C0urante (via GitHub)" <gi...@apache.org>.
C0urante commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414470212
##########
docs/ops.html:
##########
@@ -700,14 +702,14 @@ <h5 class="anchor-heading"><a id="georeplication-exactly_once" class="anchor-lin
Exactly-once semantics are supported for dedicated MirrorMaker clusters as of version 3.5.0.</p>
<p>
- For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster </code>us-east</code>, the following configuration can be used:
+ For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster <code>us-east</code>, the following configuration can be used:
Review Comment:
Never mind, I got mixed up (`<code>` is right, `<tt>` is wrong).
##########
docs/ops.html:
##########
@@ -700,14 +702,14 @@ <h5 class="anchor-heading"><a id="georeplication-exactly_once" class="anchor-lin
Exactly-once semantics are supported for dedicated MirrorMaker clusters as of version 3.5.0.</p>
<p>
- For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster </code>us-east</code>, the following configuration can be used:
+ For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster <code>us-east</code>, the following configuration can be used:
Review Comment:
Still using `<code>` tags here; should we update this as well?
##########
docs/ops.html:
##########
@@ -700,14 +702,14 @@ <h5 class="anchor-heading"><a id="georeplication-exactly_once" class="anchor-lin
Exactly-once semantics are supported for dedicated MirrorMaker clusters as of version 3.5.0.</p>
<p>
- For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster </code>us-east</code>, the following configuration can be used:
+ For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster <code>us-east</code>, the following configuration can be used:
Review Comment:
Never mind, I got mixed up (`<code>` is right, `<tt>` is wrong).
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414498206
##########
docs/ops.html:
##########
@@ -3570,7 +3572,7 @@ <h4 class="anchor-heading"><a id="others_monitoring" class="anchor-link"></a><a
<h3 class="anchor-heading"><a id="zk" class="anchor-link"></a><a href="#zk">6.9 ZooKeeper</a></h3>
<h4 class="anchor-heading"><a id="zkversion" class="anchor-link"></a><a href="#zkversion">Stable version</a></h4>
- The current stable branch is 3.5. Kafka is regularly updated to include the latest release in the 3.5 series.
+ The current stable branch is 3.8. Kafka is regularly updated to include the latest release in the 3.8 series.
Review Comment:
This is the ZooKeeper version. We don't have a variable to track that. At this point, it's likely it won't change anymore before we remove ZooKeeper, hence why I decided to just update the value.
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "C0urante (via GitHub)" <gi...@apache.org>.
C0urante commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414463486
##########
docs/ops.html:
##########
@@ -700,14 +702,14 @@ <h5 class="anchor-heading"><a id="georeplication-exactly_once" class="anchor-lin
Exactly-once semantics are supported for dedicated MirrorMaker clusters as of version 3.5.0.</p>
<p>
- For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster </code>us-east</code>, the following configuration can be used:
+ For new MirrorMaker clusters, set the <code>exactly.once.source.support</code> property to enabled for all targeted Kafka clusters that should be written to with exactly-once semantics. For example, to enable exactly-once for writes to cluster <code>us-east</code>, the following configuration can be used:
Review Comment:
Still using `<code>` tags here; should we update this 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] MINOR: Various fixes in the docs [kafka]
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414498717
##########
docs/design.html:
##########
@@ -494,12 +494,12 @@ <h3 class="anchor-heading"><a id="compaction" class="anchor-link"></a><a href="#
<li><i>Event sourcing</i>. This is a style of application design which co-locates query processing with application design and uses a log of changes as the primary store for the application.
<li><i>Journaling for high-availability</i>. A process that does local computation can be made fault-tolerant by logging out changes that it makes to its local state so another process can reload these changes and
carry on if it should fail. A concrete example of this is handling counts, aggregations, and other "group by"-like processing in a stream query system. Samza, a real-time stream-processing framework,
- <a href="http://samza.apache.org/learn/documentation/0.7.0/container/state-management.html">uses this feature</a> for exactly this purpose.
+ <a href="httsp://samza.apache.org/learn/documentation/0.7.0/container/state-management.html">uses this feature</a> for exactly this purpose.
Review Comment:
Good catch!
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison merged PR #14914:
URL: https://github.com/apache/kafka/pull/14914
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "gharris1727 (via GitHub)" <gi...@apache.org>.
gharris1727 commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414330284
##########
docs/design.html:
##########
@@ -494,12 +494,12 @@ <h3 class="anchor-heading"><a id="compaction" class="anchor-link"></a><a href="#
<li><i>Event sourcing</i>. This is a style of application design which co-locates query processing with application design and uses a log of changes as the primary store for the application.
<li><i>Journaling for high-availability</i>. A process that does local computation can be made fault-tolerant by logging out changes that it makes to its local state so another process can reload these changes and
carry on if it should fail. A concrete example of this is handling counts, aggregations, and other "group by"-like processing in a stream query system. Samza, a real-time stream-processing framework,
- <a href="http://samza.apache.org/learn/documentation/0.7.0/container/state-management.html">uses this feature</a> for exactly this purpose.
+ <a href="httsp://samza.apache.org/learn/documentation/0.7.0/container/state-management.html">uses this feature</a> for exactly this purpose.
Review Comment:
```suggestion
<a href="https://samza.apache.org/learn/documentation/0.7.0/container/state-management.html">uses this feature</a> for exactly this purpose.
```
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "C0urante (via GitHub)" <gi...@apache.org>.
C0urante commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414468321
##########
docs/ops.html:
##########
@@ -3750,9 +3752,8 @@ <h3>Limitations</h3>
<h3>Preparing for migration</h3>
<p>
- Before beginning the migration, the Kafka brokers must be upgraded to software version 3.5.0 and have the
- "inter.broker.protocol.version" configuration set to "3.5". See <a href="#upgrade_3_5_0">Upgrading to 3.5.0</a> for
- upgrade instructions.
+ Before beginning the migration, the Kafka brokers must be upgraded to software version {{fullDotVersion}} and have the
+ "inter.broker.protocol.version" configuration set to "{{dotVersion}}".
Review Comment:
Do we no longer need/want to link to the upgrade section?
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "C0urante (via GitHub)" <gi...@apache.org>.
C0urante commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414467558
##########
docs/ops.html:
##########
@@ -3570,7 +3572,7 @@ <h4 class="anchor-heading"><a id="others_monitoring" class="anchor-link"></a><a
<h3 class="anchor-heading"><a id="zk" class="anchor-link"></a><a href="#zk">6.9 ZooKeeper</a></h3>
<h4 class="anchor-heading"><a id="zkversion" class="anchor-link"></a><a href="#zkversion">Stable version</a></h4>
- The current stable branch is 3.5. Kafka is regularly updated to include the latest release in the 3.5 series.
+ The current stable branch is 3.8. Kafka is regularly updated to include the latest release in the 3.8 series.
Review Comment:
This is still hardcoded; can we programmatically render the version? Or is it automatically updated by the release script?
--
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] MINOR: Various fixes in the docs [kafka]
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison commented on code in PR #14914:
URL: https://github.com/apache/kafka/pull/14914#discussion_r1414495011
##########
docs/ops.html:
##########
@@ -3750,9 +3752,8 @@ <h3>Limitations</h3>
<h3>Preparing for migration</h3>
<p>
- Before beginning the migration, the Kafka brokers must be upgraded to software version 3.5.0 and have the
- "inter.broker.protocol.version" configuration set to "3.5". See <a href="#upgrade_3_5_0">Upgrading to 3.5.0</a> for
- upgrade instructions.
+ Before beginning the migration, the Kafka brokers must be upgraded to software version {{fullDotVersion}} and have the
+ "inter.broker.protocol.version" configuration set to "{{dotVersion}}".
Review Comment:
The link of the upgrade section use an id in the major_minor_fix format, for example upgrade_3_6_0. We currently don't have a variable holding the version in this format. I preferred not introducing another variable to update just for this. I also discarded changing the id to avoid breaking existing links.
--
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