Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat][doc] add Pulsar API content #19002

Merged
merged 1 commit into from
Dec 22, 2022
Merged

Conversation

Anonymitaet
Copy link
Member

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. More Pulsar API content will be created in the future.

image

Why add this content?

  • Based on the user behavior metrics collected from GA, 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) 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 @hangc0276 and @D-2-Ed, thank you!

And thanks for your suggestions! @BewareMyPower, @yuweisung, @tisonkun, @xiaogang-sn

cc @DaveDuggins


  • doc

@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Dec 20, 2022
@Anonymitaet Anonymitaet added this to the 2.11.0 milestone Dec 20, 2022
@Anonymitaet Anonymitaet self-assigned this Dec 20, 2022
@Anonymitaet
Copy link
Member Author

Preview looks good:

  • Pulsar API

image

  • Client API

image

  • Admin API

image

Copy link
Contributor

@momo-jun momo-jun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants