Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP MINOR: Copy over apache/kafka/3.6 docs into master #586

Open
wants to merge 1 commit into
base: asf-site
Choose a base branch
from
Open

WIP MINOR: Copy over apache/kafka/3.6 docs into master #586

wants to merge 1 commit into from

Conversation

stanislavkozlovski
Copy link
Contributor

No description provided.

stanislavkozlovski
stanislavkozlovski commented Feb 22, 2024
View reviewed changes
36/documentation.html
@@ -33,7 +33,7 @@
<!--//#include virtual="../includes/_docs_banner.htm" -->

<h1>Documentation</h1>
<h3>Kafka 3.6 Documentation</h3>
<h3>Kafka 3.4 Documentation</h3>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is stale

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apache/kafka@4302653 is missing in AK/3.6.x

Copy link
Member

@mimaison mimaison Feb 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem right. This is the 3.6 documentation so it should be Kafka 3.6.

stanislavkozlovski
stanislavkozlovski commented Feb 22, 2024
View reviewed changes
36/generated/connect_rest.yaml
@@ -8,7 +8,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: Kafka Connect REST API
version: 3.6.1
version: 3.6.2-SNAPSHOT
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't be snapshot

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again we don't want this change. The docs should cover the last released version for 3.6, hence 3.6.1.

stanislavkozlovski
stanislavkozlovski commented Feb 22, 2024
View reviewed changes
36/js/templateData.js
@@ -19,6 +19,6 @@ limitations under the License.
var context={
"version": "36",
"dotVersion": "3.6",
"fullDotVersion": "3.6.1",
"fullDotVersion": "3.6.2-SNAPSHOT",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't be snapshot, I should check out 3.6.1 and build from there I think

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we want this to stay 3.6.1

stanislavkozlovski
stanislavkozlovski commented Feb 22, 2024
View reviewed changes
36/ops.html
</pre>
</p>

<p>Try to send messages to the `tieredTopic` topic to roll the log segment:</p>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this should be kept?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to find the commit that introduced this

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I'd keep the larger section we currently have in the docs.

stanislavkozlovski
stanislavkozlovski commented Feb 22, 2024
View reviewed changes
36/upgrade.html
Every <a href="https://github.com/apache/kafka/blob/trunk/server-common/src/main/java/org/apache/kafka/server/common/MetadataVersion.java">MetadataVersion</a>
after 3.2.x has a boolean parameter that indicates if there are metadata changes (i.e. <code>IBP_3_3_IV3(7, "3.3", "IV3", true)</code> means this version has metadata changes).
Given your current and target versions, a downgrade is only possible if there are no metadata changes in the versions between.</li>
<li>Note that the cluster metadata version cannot be downgraded to a pre-production 3.0.x, 3.1.x, or 3.2.x version once it has been upgraded.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure about the source of truth here either

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok so this was fixed in 3.7+ onwards for the old versions with apache/kafka@aec07f7

stanislavkozlovski
stanislavkozlovski commented Feb 22, 2024
View reviewed changes
36/ops.html
./gradlew clean :storage:testJar</pre>
<p>After build successfully, there should be a `kafka-storage-x.x.x-test.jar` file under `storage/build/libs`.
Next, setting configurations in the broker side to enable tiered storage feature.</p>
<h4 class="anchor-heading"><a id="tiered_storage_config_ex" class="anchor-link"></a><a href="#tiered_storage_config_ex">Configurations Example</a></h4>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

81773f6 was not done in AK 3.6

mimaison
mimaison reviewed Feb 22, 2024
View reviewed changes
Copy link
Member

@mimaison mimaison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, it looks like not all doc changes were backported to 3.6 so we need to keep some updated (and correct) bits from the current kafka-site.

36/documentation.html
@@ -33,7 +33,7 @@
<!--//#include virtual="../includes/_docs_banner.htm" -->

<h1>Documentation</h1>
<h3>Kafka 3.6 Documentation</h3>
<h3>Kafka 3.4 Documentation</h3>
Copy link
Member

@mimaison mimaison Feb 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem right. This is the 3.6 documentation so it should be Kafka 3.6.

36/documentation.html
<a href="/30/documentation.html">3.0.X</a>.
<a href="/31/documentation.html">3.1.X</a>.
<a href="/32/documentation.html">3.2.X</a>.
<a href="/33/documentation.html">3.3.X</a>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the 3.6 docs, so it should point to all previous releases including 3.4 and 3.5. Why are we removing them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I don't intend to - I captured it in https://github.com/apache/kafka-site/pull/586/files#r1499488695 - that commit is missing.

36/generated/connect_rest.yaml
@@ -8,7 +8,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: Kafka Connect REST API
version: 3.6.1
version: 3.6.2-SNAPSHOT
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again we don't want this change. The docs should cover the last released version for 3.6, hence 3.6.1.

36/js/templateData.js
@@ -19,6 +19,6 @@ limitations under the License.
var context={
"version": "36",
"dotVersion": "3.6",
"fullDotVersion": "3.6.1",
"fullDotVersion": "3.6.2-SNAPSHOT",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we want this to stay 3.6.1

36/ops.html
</pre>
</p>

<p>Try to send messages to the `tieredTopic` topic to roll the log segment:</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I'd keep the larger section we currently have in the docs.

36/upgrade.html
@@ -467,7 +460,7 @@ <h5><a id="upgrade_320_notable" href="#upgrade_320_notable">Notable changes in 3
<a href="https://www.slf4j.org/codes.html#no_tlm">possible compatibility issues originating from the logging framework</a>.</li>
<li>The example connectors, <code>FileStreamSourceConnector</code> and <code>FileStreamSinkConnector</code>, have been
removed from the default classpath. To use them in Kafka Connect standalone or distributed mode they need to be
explicitly added, for example <code>CLASSPATH=./libs/connect-file-3.2.0.jar ./bin/connect-distributed.sh</code>.</li>
explicitly added, for example <code>CLASSPATH=./lib/connect-file-3.2.0.jar ./bin/connect-distributed.sh</code>.</li>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The correct path is ./libs so we should not change this line.

@stanislavkozlovski
Copy link
Contributor Author

This is still WIP, I should have marked it as such - sorry

@mjsax
Copy link
Member

mjsax commented Jun 17, 2024

@stanislavkozlovski -- what is the status of this PR?

@stanislavkozlovski stanislavkozlovski changed the title MINOR: Copy over apache/kafka/3.6 docs into here WIP MINOR: Copy over apache/kafka/3.6 docs into master Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mimaison mimaison mimaison left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stanislavkozlovski @mjsax @mimaison