Anonymitaet commented on pull request #11235:
URL: https://github.com/apache/pulsar/pull/11235#issuecomment-876070583


   Hi @lhotari thanks for your feedback.
   
   I've discussed w/ @congbobo184, we are considering making the following 
changes to doc:
   
   1.  Add `transaction` section under the `interactions` chapter
   
![image](https://user-images.githubusercontent.com/50226895/124851797-ccaf4a00-dfd5-11eb-8bd4-4676ebd66dee.png)
   
   2. Add descriptions for transaction command in the [source code 
file](https://github.com/apache/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto)
 (rather than in user guide) and add links of the [source code 
file](https://github.com/apache/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto)
 to the user guide.
   
   Reason: 
   - The descriptions are simple.
   - Developers make code changes at any time or frequently (for example,  add 
a transaction command), it is not easy to capture all code changes and sync doc 
with code. But we provide the source code file link, so that users can be 
navigated to the source code file to get the latest and complete info.
   
   3. Add a diagram (something like below) of transaction to the user guide.
   
   
![image](https://user-images.githubusercontent.com/50226895/124852349-c66d9d80-dfd6-11eb-9519-57dbca56eaec.png)
   
   Any thoughts?
   


-- 
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]


Reply via email to