Skip to content

KAFKA-12993: fix memory-mgmt.html formatting#361

Merged
ableegoldman merged 1 commit into
apache:asf-sitefrom
showuon:KAFKA-12993
Jul 13, 2021
Merged

KAFKA-12993: fix memory-mgmt.html formatting#361
ableegoldman merged 1 commit into
apache:asf-sitefrom
showuon:KAFKA-12993

Conversation

@showuon

@showuon showuon commented Jun 25, 2021

Copy link
Copy Markdown
Member

We have updated the memory-mgmt.html in kafka repo in this PR: apache/kafka#10651.
So, this pr, just simply fix the missing pre closing tag issue.

  1. add missing closing tag
  2. remove a redundant span tag

<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setConfig</span><span class="o">(</span><span class="kd">final</span> <span class="n">String</span> <span class="n">storeName</span><span class="o">,</span> <span class="kd">final</span> <span class="n">Options</span> <span class="n">options</span><span class="o">,</span> <span class="kd">final</span> <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">configs</span><span class="o">)</span> <span class="o">{</span>

<span class="n">BlockBasedTableConfig</span> <span class="n">tableConfig</span> <span class="o">=</span> <span class="k">(BlockBasedTableConfig)</span> <span class="n">options</span><span><span class="o">.</span><span class="na">tableFormatConfig</span><span class="o">();</span>
<span class="n">BlockBasedTableConfig</span> <span class="n">tableConfig</span> <span class="o">=</span> <span class="k">(BlockBasedTableConfig)</span> <span class="n">options</span><span class="o">.</span><span class="na">tableFormatConfig</span><span class="o">();</span>

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.

fix 2: remove redundant span tag

<span class="c1">// Cache and WriteBufferManager should not be closed here, as the same objects are shared by every store instance.</span>
<span class="o">}</span>
<span class="o">}</span>
</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.

fix 1: add missing pre tag

In addition to the recommended configs above, you may want to consider using partitioned index filters as described by the <a class="reference external" href="https://github.com/facebook/rocksdb/wiki/Partitioned-Index-Filters">RocksDB docs</a>.

</dl>
</sup>

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.

add missing sup tag

@showuon

showuon commented Jun 25, 2021

Copy link
Copy Markdown
Member Author

@ableegoldman , please take a look. Thanks.

@cadonna

cadonna commented Jun 25, 2021

Copy link
Copy Markdown
Member

@showuon I think this has been already done in PR #10651.

@ableegoldman

Copy link
Copy Markdown
Member

@cadonna this PR is just porting #10651 over to kafka-site, right? I agree that the basic formatting fix for the memory management docs at least should be ported to the live site ASAP.

@showuon is there also a missing </code> tag? See line 165

<p> Each instance of RocksDB allocates off-heap memory for a block cache, index and filter blocks, and memtable (write buffer). Critical configs (for RocksDB version 4.1.0) include
<code class="docutils literal"><span class="pre">block_cache_size</span></code>, <code class="docutils literal"><span class="pre">write_buffer_size</span></code> and <code class="docutils literal"><span class="pre">max_write_buffer_number</span></code>. These can be specified through the
<code class="docutils literal"><span class="pre">rocksdb.config.setter</span></code> configuration.</li>
<code class="docutils literal"><span class="pre">rocksdb.config.setter</span></code> configuration.</li></p>

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.

add missing </p> tag

@showuon

showuon commented Jun 26, 2021

Copy link
Copy Markdown
Member Author

@ableegoldman , I've checked, the line 165 for </code> change is to fix the new added doc in this PR apache/kafka#10046, not existed in V2.8. I also added a missing </p> tag. Thank you.

@ableegoldman

Copy link
Copy Markdown
Member

Gotcha, thanks for checking. Can you try setting up a local Apache server to test these changes (see instructions here)?

@showuon

showuon commented Jun 26, 2021

Copy link
Copy Markdown
Member Author

Will do and let you know. Thanks.

@showuon

showuon commented Jun 26, 2021

Copy link
Copy Markdown
Member Author

@ableegoldman , I've updated and confirmed the change can fix the formatting issue.
image

@izzyacademy

Copy link
Copy Markdown

Gotcha, thanks for checking. Can you try setting up a local Apache server to test these changes (see instructions here)?

@ableegoldman this is great to know. I was not aware of this before now. @showuon I will review it on Monday and share my feedback as well. I am looking to contribute documentation changes myself as well

@ableegoldman ableegoldman left a comment

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.

This slipped past my radar, but it looks like we're good to merge here and close out the ticket. Thanks @showuon

@ableegoldman ableegoldman merged commit 9c79452 into apache:asf-site Jul 13, 2021
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.

4 participants