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

[doc][improve] add popular topics to dev landing page #610

Merged
merged 6 commits into from
Jun 28, 2023

Conversation

Anonymitaet
Copy link
Member

This PR adds popular topics to the dev landing page to give quick guidance for devs to get familiar with Pulsar.

The popular topics (pages) are based on the data collected from GA and Matomo, which covers from concepts, tasks, and references.

  • doc

@Anonymitaet Anonymitaet added the doc Improvements or additions to documentation label Jun 14, 2023
@Anonymitaet Anonymitaet added this to the 3.1.0 milestone Jun 14, 2023
@Anonymitaet Anonymitaet self-assigned this Jun 14, 2023
@Anonymitaet
Copy link
Member Author

The preview looks good and all links work correctly.

image

@Anonymitaet
Copy link
Member Author

@D-2-Ed could you please help review? Thank you!

@jak78
Copy link
Contributor

jak78 commented Jun 14, 2023

Thank you @Anonymitaet. However, I'm not sure this is the right place to put these topics. This page is called developers-landing. It looks like it is designed for beginners because of the following text:

Developing applications for Pulsar can be a fun and rewarding experience. With Pulsar, you can quickly create, deploy, and manage your services using a powerful CLI tool and a comprehensive set of libraries. The topics below will get you started!

However, just below this text, very advanced topics are mentioned: simulation tools, binary protocol, and so on. This is not about getting started, so it seems contradictory.

My suggestion:

  • rename this page to 'Advanced topics for developers' or something similar
  • rewrite the paragraph I quoted. This page is not about developing applications for Pulsar.
  • popular topics would be on a separate page

@Anonymitaet
Copy link
Member Author

Anonymitaet commented Jun 15, 2023

Hi @jak78 thanks for your suggestions!

rename this page to 'Advanced topics for developers' or something similar
rewrite the paragraph I quoted. This page is not about developing applications for Pulsar.

How about changing this part to the following?

image

popular topics would be on a separate page

Currently, this page is the most appropriate place to show "popular topics for devs" because:

  1. this is the only landing page for devs, and these are popular topics for devs.
  2. we (+@D-2-Ed ) also consider other places, like the red box in the image below, but it's not a suitable place because these topics are only for devs. We plan to add separate "popular topics" to the dev landing page (popular topics for devs) and the operator landing page (popular topics for operators).

image

Thoughts?

@jak78
Copy link
Contributor

jak78 commented Jun 15, 2023

Hi @Anonymitaet, and thank you for your answer.

rename this page to 'Advanced topics for developers' or something similar
rewrite the paragraph I quoted. This page is not about developing applications for Pulsar.

How about changing this part to the following?

I agree

@Anonymitaet
Copy link
Member Author

Anonymitaet commented Jun 15, 2023

@jak78 thank you! I've updated it, PTAL. Feel free to approve this PR if you do not have more comments.

image

Anonymitaet added 2 commits June 16, 2023 07:41
@jak78
Copy link
Contributor

jak78 commented Jun 19, 2023

Thank you @Anonymitaet ! I would suggest moving the 'advanced' section below the 'popular' section

@Anonymitaet
Copy link
Member Author

@jak78 thanks! Done, PTAL.

docs/developers-landing.md Outdated Show resolved Hide resolved
docs/developers-landing.md Outdated Show resolved Hide resolved
docs/developers-landing.md Outdated Show resolved Hide resolved
docs/developers-landing.md Outdated Show resolved Hide resolved
docs/developers-landing.md Outdated Show resolved Hide resolved
docs/developers-landing.md Outdated Show resolved Hide resolved
Anonymitaet added 2 commits June 26, 2023 12:17
@Anonymitaet
Copy link
Member Author

Hi @D-2-Ed @jak78 @heesung-sn @Demogorgon314 updated as you suggested, PTAL.

image

@Anonymitaet
Copy link
Member Author

@jak78 thank you!

@Anonymitaet Anonymitaet merged commit 6f8d515 into apache:main Jun 28, 2023
- [Pulsar APIs](pulsar-api-overview.md)
- [Pulsar admin APIs](admin-api-overview.md)
- [Pulsar REST APIs](reference-rest-api-overview.md)
- [Pulsar contribution guide](../../contribute)
Copy link
Member

Choose a reason for hiding this comment

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

This link would break. I'll prepare a fix to it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks!
Before I submit this PR, I've previewed this link, and it goes well.
Just now I check it again, and it works.

@tisonkun tisonkun mentioned this pull request Jun 29, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants