You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/09/15 08:54:10 UTC

[GitHub] [pulsar] momo-jun opened a new pull request, #17666: [improve][doc] Improve the information architecture of encryption and cookbook

momo-jun opened a new pull request, #17666:
URL: https://github.com/apache/pulsar/pull/17666

   
   ### 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](https://pulsar.apache.org/docs/security-encryption/) is difficult to understand and follow.
   <img width="321" alt="image" src="https://user-images.githubusercontent.com/60642177/190359101-f1fd4f94-5e67-469e-9480-d4c98a7bd0c9.png">
   2. The [encryption cookbook](https://pulsar.apache.org/docs/cookbooks-encryption) 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.
   
   ### Modifications
   
   1. Re-org the encryption topic.
   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.
   
   
   ### Documentation
   
   - [ ] `doc` 
   


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] nodece commented on a diff in pull request #17666: [improve][doc] Improve the information architecture of encryption and cookbook

Posted by GitBox <gi...@apache.org>.
nodece commented on code in PR #17666:
URL: https://github.com/apache/pulsar/pull/17666#discussion_r975010568


##########
site2/docs/security-encryption.md:
##########
@@ -9,308 +9,40 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 ````
 
+Applications can use Pulsar end-to-end encryption (E2EE) to encrypt messages on the producer side and decrypt messages on the consumer side. You can use the public and private key pair that the application configures to perform encryption and decryption. Only the consumers with a valid key can decrypt the encrypted messages.

Review Comment:
   ```suggestion
   Applications can use Pulsar end-to-end encryption (E2E) to encrypt messages on the producer side and decrypt messages on the consumer side. You can use the public and private key pair that the application configures to perform encryption and decryption. Only the consumers with a valid key can decrypt the encrypted messages.
   ```



-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] momo-jun merged pull request #17666: [improve][doc] Improve the information architecture of encryption and cookbook

Posted by GitBox <gi...@apache.org>.
momo-jun merged PR #17666:
URL: https://github.com/apache/pulsar/pull/17666


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org