Skip to content
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 encryption and cookbook #17666

Merged
merged 8 commits into from
Sep 20, 2022

Conversation

momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Sep 15, 2022

Motivation

Improve the doc set of the Security chapter to provide Pulsar users with a more accurate, easy-to-understand, and comprehensive information experience.

This is a follow-up PR related to #17615.

It addresses the following main issues:

  1. The IA of encryption topic is difficult to understand and follow.
  2. The encryption cookbook is a complete duplicate of the above encryption topic.
  3. The encryption tutorial is available for Python and Node.js clients, but missing for Java/C++/Go. It also shares the same get-started framework and can be streamlined using code tabs.
  4. The security overview lacks focus.

Modifications

  1. Re-org the encryption topic and its content.
    image --> image

  2. Streamline the encryption tutorial on various clients and add the contents for Java/C++/Go clients.

  3. Replace the original cookbook content with the new tutorial.

  4. Improve the security overview by highlighting three pillars: encryption, authentication, and authorization, with links for further reading.

Preview

Security Overview
image
image

Encryption
image
image

Cookbook
image

Documentation

  • doc

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 15, 2022
@momo-jun momo-jun self-assigned this Sep 19, 2022
@momo-jun momo-jun marked this pull request as ready for review September 19, 2022 08:28
Copy link
Member

@nodece nodece left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants