-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
[improve][doc] Improve the information architecture of the security chapter #17615
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good to me.
.build(); | ||
``` | ||
|
||
#### Supported pattern formats |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
###
instead of####
? -
Other headings are in the format of "Verb + xxx" while this heading is not.
Consider keeping consistent or turning this section into other content formats (like moving lines 97 - 100 to line 74)?
So that users know the relationship between the section Configure Athenz authentication in Pulsar clients
and Supported pattern formats
(the info in Supported pattern format
can be a part of Configure Athenz authentication in Pulsar clients
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's copied and pasted here from another topic. I guess the intention was kind of to be a reference sub-topic so that's why ####
was used (not shown in the hot links). Thanks for the reminder. It will be evaluated in a further review throughout the topic.
@nodece thanks for the review. Your comments have been addressed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@DaveDuggins This is the improvement I mentioned on this Wednesday. Feel free to take a look and comment. |
Motivation
Improve the doc set of the
Security
chapter to provide Pulsar users with a more accurate, easy-to-read, and comprehensive information experience.Note: This PR is a quick change to the overall IA of security topics. I will include more detailed IA changes and content changes for encryption and authentication in a couple of follow-up PRs, such as #17666.
Modifications
---->
TLS encryption/authentication using Keystore
sections to related parent topics, and removeUse TLS with KeyStore
topic.Preview looks good. I've checked all the topics and here is one of the screenshots.
Documentation
doc