asafm commented on issue #19912:
URL: https://github.com/apache/pulsar/issues/19912#issuecomment-1510200982
Ok. I'll try to combine the suggestion made above.
How about we'll have 3 headings as below:
* Quick-start
* Developers Guide
* Getting Started
* Operators Guide
* Getting Started
The quick start will contain the content I've placed under "Consume and
Produce messages using the CLI". The main idea: give any role the ability to
"feel" Pulsar locally, using the CLI.
The Developer Guide will be, over time, a comprehensive guide, like a book,
to learn Pulsar targeted at Developers. It's Getting Started section will
contain what placed under "Developer Getting Started", mainly aimed at people
who wish to learn by "hand" as I explained in previous comments and in the PIP.
Same with The Operator Guide, but for Operators (DevOps).
------
@tisonkun @D-2-Ed
I don't like to call it the Getting Started section a tutorial, although it
is built as one. People expects a Getting Started section to look like a
tutorial.
I do think in the future we can have a dedicated Tutorial subsection for
each guide.
----
@tisonkun
> For three journeys in the proposal, we have contents for two of them:
>
> Getting started with CLI:
> https://pulsar.apache.org/docs/2.11.x/getting-started-home/
> Getting started for sample applications:
> https://pulsar.apache.org/docs/2.11.x/how-to-landing/
>
The CLI journey - I plan to take the content from all three, but I simply
structure it differently:
Based on the revised solution I wrote, it will be located under Quick-start.
Under it, you'll have two steps:
(1) Starting Pulsar Locally
(2) Publish and Consume messages using the CLI
The (1) will contain subsections to start it locally using binary
downloaded, or docker, both in stand-alone mode, or using docker compose as a
complete cluster (including ZK, BK).
Once you have a cluster up and running, you can continue to step (2) and use
the CLI to publish and consume messages.
Today, it's copied and pasted cross each flavor of starting Pulsar.
So in summary, I plan to re-use the existing content, and mainly restructure
it.
Regarding the Developer Guide / Getting Started. You mentioned
"https://pulsar.apache.org/docs/2.11.x/how-to-landing/";. This gives you a
broken up tutorial (not one with steps).
Most importantly, it is not using code. Only via command line. The developer
getting started section aimed to have a working application. Actually, 2 of
those, matching the most popular use cases for pulsar, as detailed in the PIP.
I hoped I answer all of your comments @tisonkun @D-2-Ed @Anonymitaet.
Would love to hear your feedback on the suggestion I wrote in the beginning
of the comment.
--
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]
