Anonymitaet opened a new pull request, #501:
URL: https://github.com/apache/pulsar-site/pull/501

   
   ## What issues does this PR solve?
   
   Currently, there are some issues in the [Pulsar transactions 
doc](https://pulsar.apache.org/docs/next/txn-use/) (as stated in 
https://github.com/apache/pulsar/issues/19996). 
   
   I’ve summarized all issues with the corresponding solutions below. 
   
   Issues | Solutions
   -- | --
   Get started: doc structure is not clear. | Optimize the doc structure by 
setting appropriate headings.
   Get started: docs are not "MVP" for a quick start. | Move some docs to the 
newly added topic ("advanced features") to keep learners focused on the minimal 
info to run it up.
   Get started: some examples are incorrect. | Remove old examples and add new 
steps and examples.
   Whole txn doc: sidebar labels are too long. | Streamline them to highlight 
points and save space.
   
   ## What doc changes does this PR introduce?
   
   ### ✅ High-level structure changes
   
   🍊Old structure VS. 🍊New structure
   
   <img width="791" alt="image" 
src="https://user-images.githubusercontent.com/50226895/229537637-6ae257a1-7587-4c18-a891-da2256e98a7b.png";>
   
   ==================================
   
   - [x] `doc` 
   
   Ping @D-2-Ed to review. Thank you!
   


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