RocMarshal commented on code in PR #26902:
URL: https://github.com/apache/flink/pull/26902#discussion_r2392314124
##########
docs/layouts/shortcodes/generated/history_server_configuration.html:
##########
@@ -30,7 +30,13 @@
<td><h5>historyserver.archive.retained-jobs</h5></td>
<td style="word-wrap: break-word;">-1</td>
<td>Integer</td>
- <td>The maximum number of jobs to retain in each archive directory
defined by `historyserver.archive.fs.dir`. If set to `-1`(default), there is no
limit to the number of archives. If set to `0` or less than `-1` HistoryServer
will throw an <code
class="highlighter-rouge">IllegalConfigurationException</code>. </td>
+ <td>The maximum number of jobs to retain in each archive directory
defined by <code class="highlighter-rouge">historyserver.archive.fs.dir</code>.
<ul><li>If the option is not specified as a positive number without specified
<code class="highlighter-rouge">historyserver.archive.retained-ttl</code>, the
all of jobs archive will be retained. </li><li>If the option is specified as a
positive number without specified value of <code
class="highlighter-rouge">historyserver.archive.retained-ttl</code>, the jobs
archive whose order index based modification time is equals to or less than the
value will be retained. </li><li>If this option is specified as a positive
number together with the specified <code
class="highlighter-rouge">historyserver.archive.retained-ttl</code> option, the
job archive will be removed if its TTL has expired or the retained job count
has been reached. </li></ul>If set to <code class="highlighter-rouge">0</code>
or less than <code class="highlighter-rouge
">-1</code>, HistoryServer will throw an <code
class="highlighter-rouge">IllegalConfigurationException</code>. <br />Note,
when there are multiple history server instances, two recommended approaches
when using this option are: <ul><li>Specify the option in only one
HistoryServer instance to avoid errors caused by multiple instances
simultaneously cleaning up remote files, </li><li>Or you can keep the value of
this configuration consistent across them. </li></ul></td>
Review Comment:
>nits: It is up to you if you want to change.
as a positive number without specified -> as a positive number without
specifying
the all of jobs archive will be retained. -> all of the jobs archives will
be retained.
If the option is specified as a positive number without specified value of
-> If the option is specified as a positive number without a specified value of
That makes sense to me.
Updated.
> I am wondering if a table would be clearer to show the various
permutations.
Sounds great.
In my limited read, the descriptions of these configuration options are
currently generated into a table.
It’s just that I haven’t found any precedent for generating a subtable
inside a single cell of a table.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
