Skip to content

MINOR: Refresh of the docs#16375

Merged
mimaison merged 4 commits intoapache:trunkfrom
mimaison:docs-update
Jun 18, 2024
Merged

MINOR: Refresh of the docs#16375
mimaison merged 4 commits intoapache:trunkfrom
mimaison:docs-update

Conversation

@mimaison
Copy link
Copy Markdown
Member

  • Remove line numbers for non-code formatted blocks
  • Use consistent prompt $ for all bash commands
  • Remove outdated zookeeper content
  • Cleanup of HTML formatting

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

Copy link
Copy Markdown
Member

@showuon showuon left a comment

Choose a reason for hiding this comment

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

LGTM! But it might be better if you could run this doc change locally and have screenshot to make sure it works as expected, especially the quickstart section. Thanks.

@mimaison
Copy link
Copy Markdown
Member Author

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

Copy link
Copy Markdown
Member

@showuon showuon left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks.

@mimaison
Copy link
Copy Markdown
Member Author

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

@showuon
Copy link
Copy Markdown
Member

showuon commented Jun 18, 2024

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

It's fine. It looks good. Thanks.

mimaison added 2 commits June 18, 2024 15:45
- Remove line numbers for non-code formatted blocks
- Use consistent prompt $ for all bash commands
- Remove outdated zookeeper content
- Cleanup of HTML formatting
Copy link
Copy Markdown
Member

@chia7712 chia7712 left a comment

Choose a reason for hiding this comment

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

@mimaison nice patch. two comments are left

<p>Invoke the application reset tool from the command line</p>
<p>Warning! This tool makes irreversible changes to your application. It is strongly recommended that you run this once with <code class="docutils literal"><span class="pre">--dry-run</span></code> to preview your changes before making them.</p>
<pre class="line-numbers"><code class="language-bash">&lt;path-to-kafka&gt;/bin/kafka-streams-application-reset</code></pre>
<pre<code class="language-bash">$ bin/kafka-streams-application-reset</code></pre>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

<pre<code -> <pre><code

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed

Comment thread docs/implementation.html Outdated
<h4 class="anchor-heading"><a id="record" class="anchor-link"></a><a href="#record">5.3.2 Record</a></h4>
<p>Record level headers were introduced in Kafka 0.11.0. The on-disk format of a record with Headers is delineated below. </p>
<pre class="line-numbers"><code class="language-text">length: varint
<pre"><code class="language-text">length: varint
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

<pre"> -> <pre>

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed

Copy link
Copy Markdown
Member

@chia7712 chia7712 left a comment

Choose a reason for hiding this comment

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

LGTM

@mimaison
Copy link
Copy Markdown
Member Author

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

@mimaison mimaison merged commit c4a3d24 into apache:trunk Jun 18, 2024
@mimaison mimaison deleted the docs-update branch June 18, 2024 15:15
TaiJuWu pushed a commit to TaiJuWu/kafka that referenced this pull request Jul 4, 2024
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
@C0urante
Copy link
Copy Markdown
Contributor

@mimaison would it be possible to backport this to 3.8, since it contains a syntax fix for the Connect quickstart? I've opened apache/kafka-site#615 to port that specific change over to our docs site, but want to make sure it doesn't get overwritten when we publish 3.8.1.

@mimaison
Copy link
Copy Markdown
Member Author

Yeah ideally we'd like want to sync all these to the website before 3.9. Should we wait for 3.8.0 to be out before backporting to 3.8?

@C0urante
Copy link
Copy Markdown
Contributor

Yeah, that should be fine, thanks!

mimaison added a commit that referenced this pull request Jul 30, 2024
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
@mimaison
Copy link
Copy Markdown
Member Author

Backported to 3.8: 57c50e3

@jlprat
Copy link
Copy Markdown
Contributor

jlprat commented Jul 30, 2024

Shall we mimic this PR in kafka-site?

@mimaison
Copy link
Copy Markdown
Member Author

Yes, I'll open a PR for kafka-site this afternoon.

@jlprat
Copy link
Copy Markdown
Contributor

jlprat commented Jul 30, 2024

Ping me and I'll review it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants