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/12/20 10:30:55 UTC
[GitHub] [pulsar] Anonymitaet opened a new pull request, #19002: [feat][doc] add Pulsar API content
Anonymitaet opened a new pull request, #19002:
URL: https://github.com/apache/pulsar/pull/19002
### What content does this PR add?
- This doc adds the content in green (1️⃣2️⃣3️⃣). They are totally newly created and in parallel with each other as independent topics in Pulsar docs.
- Currently, 2️⃣ is not placed in 4️⃣ (client libraries) because we’re optimizing the structure of 4️⃣, and 2️⃣ does not fit in 4️⃣ temporarily. Once we have a final and better solution, we’ll tweak the structure, but below is the structure that makes the most sense for now.
- This doc is the beginning of [Building Great Developer Experience with API Content](https://docs.google.com/document/d/1NWmfDyIyUGzXOqX8V28AHyORF72lTFIvxlM6n86wAfU/edit?pli=1#heading=h.r3dt8xy5x3a3). More [Pulsar API content](https://docs.google.com/document/d/1NWmfDyIyUGzXOqX8V28AHyORF72lTFIvxlM6n86wAfU/edit?pli=1#bookmark=id.h0fmcaa7oxzs) will be created in the future.
<img width="740" alt="image" src="https://user-images.githubusercontent.com/50226895/208643937-6dab3295-fc75-42e6-9b40-f7e16dca9bc0.png">
### Why add this content?
- Based on the [user behavior metrics collected from GA](https://docs.google.com/document/d/1H-wEEfut18M18dle6a4-2EWCnLOqyJ81RVYxkPkTXhk/edit), the Pulsar API doc is one of the top-viewed content. However, we do not have a page to explain Pulsar API systematically.
- This doc aims to provide landing pages (e.g. [Get Started - Landing Page](https://pulsar.apache.org/docs/next/getting-started-home/)) for Pulsar API, Client API, and Admin API and organically correlate them. I make them succinct, self-contained, and robustly linked rather than flooding users with too much info.
-------
This content has been reviewed and [approved by](https://docs.google.com/document/d/1uXAu0NSI2LzmQGnOwSha86wdJdaRTIjT1wVjuaoydns/edit?pli=1#heading=h.n50o2k1v4tad) @hangc0276 and @D-2-Ed, thank you!
And thanks for your suggestions! @BewareMyPower, @yuweisung, @tisonkun, @xiaogang-sn
cc @DaveDuggins
-------
- [x] `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] Anonymitaet merged pull request #19002: [feat][doc] add Pulsar API content
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #19002:
URL: https://github.com/apache/pulsar/pull/19002
--
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] Anonymitaet commented on pull request #19002: [feat][doc] add Pulsar API content
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #19002:
URL: https://github.com/apache/pulsar/pull/19002#issuecomment-1359157898
Preview looks good:
- Pulsar API
<img width="1340" alt="image" src="https://user-images.githubusercontent.com/50226895/208646902-ab7fc8c8-4a1b-42e5-9214-17f794c57534.png">
- Client API
<img width="1620" alt="image" src="https://user-images.githubusercontent.com/50226895/208647072-8dcd886d-59bf-4f01-8fbc-20171c4ade27.png">
- Admin API
<img width="1488" alt="image" src="https://user-images.githubusercontent.com/50226895/208647237-35e482e2-7567-49af-833e-901873ab4b58.png">
--
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