Hi Pulsar Community, I would like to propose earning featured snippets for Pulsar Doc.
*## Motivation* Featured snippets [1] provide a brief text that directly answers the searcher's query. In Google search results, featured snippets appear at the top where usually called “Page 0” and it contributes significantly to the pageview of a website. Among all SEO [2] (Search Engine Optimization) strategies, earning a featured snippet is the primary and most effective method. Therefore, I would like to propose making some small modifications to the Pulsar documentation to earn more featured snippets, thereby improving pageview numbers. [1] https://developers.google.com/search/docs/appearance/featured-snippets [2] https://developers.google.com/search/docs/fundamentals/seo-starter-guide *## How to earn more featured snippets for Pulsar doc* The Pulsar doc already has a certain level of authority. By standardizing the format to make the content easily understandable by search engines, there is a high probability of generating featured snippets. The types of featured snippets that Pulsar doc can generate typically correspond to definition, unordered list, and ordered list. By drawing on some SEO best practices and studying how other websites create featured snippets, I have summarized the techniques for generating featured snippets as follows: - definition Google typically uses definition boxes to answer searches for "what is (are) X". The average length of these snippets ranges from 40 to 60 words. To generate this type of featured snippet, we need to explicitly write sentences in the document using the structure "X is (are) …" and emphasize the defining part. - unordered list This is a list of displayed items that do not need to be arranged in a specific order. To generate this type of featured snippet, Place each item on a separate line and precede it with a bullet point for the list. - ordered list This is a list displayed in a specific order, corresponding to the "How to ..." type of query. To generate this type of featured snippet, we should use a series of summary-style subheadings in the body of the content and explicitly define each step by adding the relevant phrases like "Step 1 Step 2 Step 3 ..." or "1. 2. 3. …" before them. For more detailed information, please see this discussion [3]. [3] https://github.com/apache/pulsar/discussions/20897 *## Schedule* In the next two months, I will do SEO for Pulsar Doc [4], which includes optimizing the content to earn featured snippets and adding meta descriptions [5] and alt tags [6]. [4] https://pulsar.apache.org/docs/next/ [5] https://developers.google.com/search/docs/appearance/snippet [6] https://developers.google.com/search/docs/appearance/google-images I welcome any feedback or thoughts you may have on this issue. Best, Yuxuan.
