Anonymitaet commented on issue #17409: URL: https://github.com/apache/pulsar/issues/17409#issuecomment-1234964144
@tisonkun thanks for raising this up! I'm on your side to make it more concise and task-focused. Here are my two cents: ☘️☘️☘️ ### General structure It can be: - Prerequisites - Install Pulsar - Run Pulsar - Next steps (It provides hints and related useful resources). For example, > - To learn how other users are getting value out of Pulsar, see [Pulsar Case Studies](https://pulsar.apache.org/case-studies). > - To know how Pulsar solves infrastructure challenges and how it compares to similar projects, see [Pulsar Concepts and Architecture](https://pulsar.apache.org/docs/next/concepts-overview). > - To use Pulsar in real-world applications, see [Use Pulsar Client](https://pulsar.apache.org/docs/client-libraries). ☘️☘️☘️ ### Binary release info > We don't have to talk in detail about the layout of the binary release directory. It's intuitive and can be read from their name. Does "layout of the binary release directory" refer to [What your package contains](https://pulsar.apache.org/docs/next/getting-started-standalone#what-your-package-contains)? If so, suggest keeping this part since 1) some directory names do not reflect the contents 2) it provides more context for novices We can change the way to show this part if it occupies too much space before `Run Pulsar`. ☘️☘️☘️ #### Install connectors and offloaders I'm with you to relocate this part. They can be moved to the `Get Started` chapter of `Connector` and `Tiered Storage` guides. ☘️☘️☘️ ### Run Pulsar > Also, Pulsar CLI has some significant arguments to play with basic messaging, like how to consume from Earliest, how to keep consuming messaging instead of consuming only one message, and how to produce multiple messages in one turn. +1 for adding a few **simple** examples of different behaviors of consuming/producing msgs. ☘️☘️☘️ ### FAQ To locate troubleshooting info (eg. `how to install JDK on M1`, other solutions for common issues, etc), which way do you prefer? - Method 1: put them in the `FAQ` chapter at the end of the `Get stated` guide, like [Chaos Mesh](https://chaos-mesh.org/docs/quick-start/#faq). - Method 2: collect all common issues and solutions in another place (eg. Create an independent `Troubleshooting` guide, create posts on [Discussions](https://github.com/apache/pulsar/discussions), or elsewhere) and attach its link to the `Get Started` guide ☘️☘️☘️ 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]
