You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "zuobiao-zhou (via GitHub)" <gi...@apache.org> on 2023/08/14 09:10:16 UTC

[GitHub] [pulsar-site] zuobiao-zhou opened a new pull request, #675: [improve][doc] SEO for Pulsar Schema

zuobiao-zhou opened a new pull request, #675:
URL: https://github.com/apache/pulsar-site/pull/675

   
   
   This PR do SEO for Pulsar Schema
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   - [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `./preview.sh` at root path) to your PR description, or else your PR might not get merged. -->
   - [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
   - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
   - [ ] `doc-complete` <!-- Docs have been already added -->
   
   cc @Anonymitaet 
   


-- 
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-site] Anonymitaet merged pull request #675: [improve][doc] SEO for Pulsar Schema

Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet merged PR #675:
URL: https://github.com/apache/pulsar-site/pull/675


-- 
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-site] Anonymitaet commented on a diff in pull request #675: [improve][doc] SEO for Pulsar Schema

Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on code in PR #675:
URL: https://github.com/apache/pulsar-site/pull/675#discussion_r1295330344


##########
docs/schema-get-started.md:
##########
@@ -2,6 +2,7 @@
 id: schema-get-started
 title: Get started
 sidebar_label: "Get started"
+description: Get started to construct Pulsar schemas and Customize Pulsar schema storage.

Review Comment:
   Why capitalize "C"?



##########
docs/schema-overview.md:
##########
@@ -2,12 +2,13 @@
 id: schema-overview
 title: Overview
 sidebar_label: "Overview"
+description: Get a comprehensive understanding of Pulsar schema.
 ---
 
 This section introduces the following content:
 * [What is Pulsar Schema](#what-is-pulsar-schema)
-* [Why use it](#why-use-it)
-* [How it works](#how-it-works)
+* [Why use it](#why-use-Pulsar-Schema)
+* [How it works](#how-Pulsar-Schema-works)
 * [Use case](#use-case)
 * [What's next?](#whats-next)

Review Comment:
   Line 8 - 13 can be removed since it's duplicated with the right ToC



##########
docs/schema-understand.md:
##########
@@ -2,6 +2,7 @@
 id: schema-understand
 title: Understand schema
 sidebar_label: "Understand schema"
+description: Get a comprehensive understanding of concepts of Pulsar schema.

Review Comment:
   ```suggestion
   description: Get a comprehensive understanding of Pulsar schemas.
   ```
   This topic does not only cover "concepts"



##########
docs/schema-overview.md:
##########
@@ -27,7 +28,7 @@ Currently, Pulsar schema is available for [Java clients](client-libraries-java.m
 
 :::
 
-## Why use it
+## Why use Pulsar Schema

Review Comment:
   ```suggestion
   ## Benefits
   ```



##########
docs/schema-overview.md:
##########
@@ -38,15 +39,17 @@ Pulsar schema resolves the pain points with the following capabilities:
 * keeps data compatibility on-track between schema versions. When new schemas are uploaded, the new versions can be read by old consumers.
 * stored in the existing storage layer BookKeeper, without additional system required.
 
-## How it works
+## How Pulsar Schema works

Review Comment:
   ```suggestion
   ## Workflow
   ```



##########
docs/schema-overview.md:
##########
@@ -2,12 +2,13 @@
 id: schema-overview
 title: Overview
 sidebar_label: "Overview"
+description: Get a comprehensive understanding of Pulsar schema.
 ---
 
 This section introduces the following content:
 * [What is Pulsar Schema](#what-is-pulsar-schema)
-* [Why use it](#why-use-it)
-* [How it works](#how-it-works)
+* [Why use it](#why-use-Pulsar-Schema)
+* [How it works](#how-Pulsar-Schema-works)
 * [Use case](#use-case)
 * [What's next?](#whats-next)

Review Comment:
   Line 15 can be updated to "Definitions" to make headings shorter



##########
docs/schema-overview.md:
##########
@@ -69,7 +72,9 @@ This diagram illustrates how Pulsar schema works on the Producer side.
 
 This diagram illustrates how schema works on the consumer side.
 
-![How Pulsar schema works on the consumer side](/assets/schema-consumer.svg)
+![Workflow of Pulsar schema on the consumer side](/assets/schema-consumer.svg)
+
+Pulsar schema works on the consumer side in the following steps:

Review Comment:
   ```suggestion
   Below are explanations for each step. 
   ```



##########
docs/schema-overview.md:
##########
@@ -38,15 +39,17 @@ Pulsar schema resolves the pain points with the following capabilities:
 * keeps data compatibility on-track between schema versions. When new schemas are uploaded, the new versions can be read by old consumers.
 * stored in the existing storage layer BookKeeper, without additional system required.
 
-## How it works
+## How Pulsar Schema works
 
 Pulsar schemas are applied and enforced at the **topic** level. Producers and consumers can upload schemas to brokers, so Pulsar schemas work on both sides.
 
 ### Producer side
 
-This diagram illustrates how Pulsar schema works on the Producer side.
+This diagram illustrates how Pulsar schema works on the producer side.
 
-![How Pulsar schema works on the producer side](/assets/schema-producer.svg)
+![Workflow of Pulsar schema on the producer side](/assets/schema-producer.svg)
+
+Pulsar schema works on the Producer side in the following steps:

Review Comment:
   ```suggestion
   Below are explanations for each step. 
   ```
   We already have a featured snippet for this workflow. So keep this introductory sentence concise.
   
   ---
   
   <img width="821" alt="image" src="https://github.com/apache/pulsar-site/assets/50226895/dab8c36d-0686-42c3-a92e-a75233038c6b">
   



-- 
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-site] zuobiao-zhou commented on pull request #675: [improve][doc] SEO for Pulsar Schema

Posted by "zuobiao-zhou (via GitHub)" <gi...@apache.org>.
zuobiao-zhou commented on PR #675:
URL: https://github.com/apache/pulsar-site/pull/675#issuecomment-1683211325

   fixed, PTAL @Anonymitaet 


-- 
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