MINOR: fix code listings security.html #10770
Conversation
Fix examples under security.html so they use the right bash icon (`>` instead of `$`) and also uses the right tool for showing code listings
|
CC. @cadonna as you reviewed the last doc changes on formatting and styling, you might want to review these as well. I split the changes in several PRs so it's more bearable to review. |
| login module may be specified in the config value. If multiple mechanisms are configured on a | ||
| listener, configs must be provided for each mechanism using the listener and mechanism prefix. | ||
| For example, | ||
| <p>Brokers may also configure JAAS using the broker configuration property <code>sasl.jaas.config</code>. |
There was a problem hiding this comment.
Line 402-408 has ol and li tag not get handled. Please help. Thanks.
https://github.com/apache/kafka/pull/10770/files#diff-3485b37e32662f4925ee0374c4f6eb1d4dfa589bbb1c148b2a70e92b4acbe8bdR402-R408
There was a problem hiding this comment.
That li tag is currently closed at line 508. It's a 3 level nested ordered lists. Between line 402 and 508 we have the whole sublists as part of that li element. That's the reason the closing li element seems to be missing, it's just really down the page.
| @@ -1835,28 +1834,28 @@ <h5 class="anchor-heading"><a id="operations_resources_and_protocols" class="anc | |||
| <td></td> | |||
| <td></td> | |||
| <td>Creating delegation tokens has special rules, for this please see the | |||
| <a id="security_delegation_token" href="#security_delegation_token">Authentication using Delegation Tokens</a> section.</td> | |||
| <a id="security_delegation_token_1" href="#security_delegation_token">Authentication using Delegation Tokens</a> section.</td> | |||
docs/security.html
Outdated
| <p>Brokers may also configure JAAS using the broker configuration property <code>sasl.jaas.config</code>. | ||
| The property name must be prefixed with the listener prefix including the SASL mechanism, | ||
| i.e. <code>listener.name.{listenerName}.{saslMechanism}.sasl.jaas.config</code>. Only one | ||
| login module may be specified in the config value. If multiple mechanisms are configured on a | ||
| listener, configs must be provided for each mechanism using the listener and mechanism prefix. | ||
| For example, |
There was a problem hiding this comment.
Why the indentation here? It should be on the same level as the previous paragraph, right?
There was a problem hiding this comment.
Actually, it seems the above paragraphs should be indented to the right, there are several nested <ol> and <li> and <p> that didn't follow indentation.
I'm fixing these now.
There was a problem hiding this comment.
I think we misunderstood each other. The line that starts with The property name ... should be aligned with <p>Brokers may also .... I am also fine, if you do not fix that. I think it is understandable and I see that the indentation is not really consistent in this file.
| For example, <a href="#security_sasl_gssapi_clientconfig">GSSAPI</a> | ||
| credentials may be configured as: | ||
| <pre class="line-numbers"><code class="language-text">KafkaClient { | ||
| If JAAS configuration is defined at different levels, the order of precedence used is: |
There was a problem hiding this comment.
Also this indentation do not seem to align to the previous section header JAAS configuration for Kafka brokers.
There was a problem hiding this comment.
Same as previous, you are right, it needs to be aligned with the contents of the header JAAS configuration for Kafka brokers. However, the problem here was that the previous content was misaligned.
|
Hi @cadonna thanks a lot for the feedback. I fixed the missing |
docs/security.html
Outdated
| <p>Brokers may also configure JAAS using the broker configuration property <code>sasl.jaas.config</code>. | ||
| The property name must be prefixed with the listener prefix including the SASL mechanism, | ||
| i.e. <code>listener.name.{listenerName}.{saslMechanism}.sasl.jaas.config</code>. Only one | ||
| login module may be specified in the config value. If multiple mechanisms are configured on a | ||
| listener, configs must be provided for each mechanism using the listener and mechanism prefix. | ||
| For example, |
There was a problem hiding this comment.
I think we misunderstood each other. The line that starts with The property name ... should be aligned with <p>Brokers may also .... I am also fine, if you do not fix that. I think it is understandable and I see that the indentation is not really consistent in this file.
|
Thanks @cadonna All comments addressed! |
|
The test failures are unrelated since this is a pure doc change. |
|
Thanks @cadonna ! |
Fix examples under security.html so they use the right bash icon (
>instead of
$) and also uses the right tool for showing code listingsSome of the diffs are caused also by the IDE aligning html code properly.
Committer Checklist (excluded from commit message)