You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "Anonymitaet (via GitHub)" <gi...@apache.org> on 2023/08/16 03:59:06 UTC
[GitHub] [pulsar-site] Anonymitaet commented on a diff in pull request #676: [improve][doc] SEO for Pulsar IO
Anonymitaet commented on code in PR #676:
URL: https://github.com/apache/pulsar-site/pull/676#discussion_r1295345973
##########
docs/io-connectors.md:
##########
@@ -2,11 +2,12 @@
id: io-connectors
title: Built-in connector
sidebar_label: "Built-in connector"
+description: Get a comprehensive understanding of configuration, example, and Java class of Pulsar IO connectors.
Review Comment:
```suggestion
description: Learn configuration, examples, and Java classes of Pulsar IO connectors.
```
##########
docs/io-develop.md:
##########
@@ -140,7 +140,7 @@ For more information about **how to create a source connector**, see {@inject: g
### Sink
-Developing a sink connector **is similar to** developing a source connector, that is, you need to implement the {@inject: github:Sink:/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java} interface, which means implementing the {@inject: github:open:/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java} method and the {@inject: github:write:/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java} method.
+To develop a sink connector, you need to implement the {@inject: github:open:/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java} method and the {@inject: github:write:/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java} method, essentially implementing the {@inject: github:Sink:/pulsar-io/core/src/main/java/org/apache/pulsar/io/core/Sink.java} interface.
Review Comment:
Why change the order of two Java files? The original logic looks good.
##########
docs/io-overview.md:
##########
@@ -103,7 +111,7 @@ For more information about the options of `pulsar-admin sinks create`, see [here
</Tabs>
````
-### Update
+### How to update the processing guarantee
Review Comment:
```suggestion
### Update processing guarantees
```
##########
docs/io-use.md:
##########
@@ -30,11 +31,11 @@ After the setup, the built-in connector is automatically discovered by Pulsar br
You can configure the following information:
-* [Configure a default storage location for a connector](#configure-a-default-storage-location-for-a-connector)
+* [Configure a default storage location for built-in connectors](#configure-a-default-storage-location-for-built-in-connectors)
* [Configure a connector with a YAML file](#configure-a-connector-with-a-yaml-file)
-### Configure a default storage location for a connector
+### Configure a default storage location for built-in connectors
Review Comment:
```suggestion
### Configure a default storage location for a built-in connector
```
##########
docs/io-use.md:
##########
@@ -105,21 +106,21 @@ configs:
tableName: "test_jdbc"
```
-## Get available connectors
+## Prepare a connector
Before starting using connectors, you can perform the following operations:
-* [Reload connectors](#reload)
+* [Reload connectors](#reload-connectors)
-* [Get a list of available connectors](#get-available-connectors)
+* [Get a list of available connectors](#get-a-list-of-available-connectors)
-### `reload`
+### Reload connectors
Review Comment:
```suggestion
### `reload`
```
Keep the original text as it is since it's the same as the command https://pulsar.apache.org/reference/#/next/pulsar-admin/sources?id=reload
Besides, 2-level headings already show the explanations
<img width="292" alt="image" src="https://github.com/apache/pulsar-site/assets/50226895/045e24e0-592a-4fa1-86c4-ebd12e8a3a2e">
##########
docs/io-use.md:
##########
@@ -161,19 +162,19 @@ pulsar-admin sinks available-sinks
To run a connector, you can perform the following operations:
-* [Create a connector](#create)
+* [Create a connector](#create-a-connector)
-* [Start a connector](#start)
+* [Start a connector](#start-a-connector)
-* [Run a connector locally](#localrun)
+* [Run a connector locally](#run-a-connector-locally)
-### `create`
+### Create a connector
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -801,13 +802,13 @@ For more information, see [`listSource`](/api/admin/org/apache/pulsar/client/adm
</Tabs>
````
-### `status`
+### Get the current status of a connector
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -105,21 +106,21 @@ configs:
tableName: "test_jdbc"
```
-## Get available connectors
+## Prepare a connector
Before starting using connectors, you can perform the following operations:
-* [Reload connectors](#reload)
+* [Reload connectors](#reload-connectors)
-* [Get a list of available connectors](#get-available-connectors)
+* [Get a list of available connectors](#get-a-list-of-available-connectors)
Review Comment:
Keep headings short
##########
docs/io-overview.md:
##########
@@ -26,17 +30,17 @@ This diagram illustrates the relationship between source, Pulsar, and sink:
### Source
-> Sources **feed data from external systems into Pulsar**.
+Source connectors **feed data from external systems into Pulsar**.
-Common sources include other messaging systems and firehose-style data pipeline APIs.
+Common source connectors include other messaging systems and firehose-style data pipeline APIs.
For the complete list of Pulsar built-in source connectors, see [source connector](io-connectors.md#source-connector).
### Sink
-> Sinks **feed data from Pulsar into external systems**.
+Sink connectors **feed data from Pulsar into external systems**.
-Common sinks include other messaging systems and SQL and NoSQL databases.
+Common sink connectors include other messaging systems and SQL and NoSQL databases.
Review Comment:
```suggestion
Common sinks include other messaging systems and SQL and NoSQL databases.
```
##########
docs/io-overview.md:
##########
@@ -17,7 +18,10 @@ Messaging systems are most powerful when you can easily use them with external s
## Concept
-Pulsar IO connectors come in two types: **source** and **sink**.
+Pulsar IO connectors come in two types:
+
+- Source
+- Sink
Review Comment:
same
##########
docs/io-use.md:
##########
@@ -691,13 +692,13 @@ For more information, see [`getSink`](/api/admin/org/apache/pulsar/client/admin/
</Tabs>
````
-### `list`
+### Get the list of all running connectors
Review Comment:
same as above
##########
docs/io-debug.md:
##########
@@ -2,6 +2,7 @@
id: io-debug
title: How to debug Pulsar connectors
sidebar_label: "Debug"
+description: Get started to debug Pulsar connectors.
Review Comment:
```suggestion
description: Learn how to debug Pulsar connectors.
```
##########
docs/io-overview.md:
##########
@@ -17,7 +18,10 @@ Messaging systems are most powerful when you can easily use them with external s
## Concept
-Pulsar IO connectors come in two types: **source** and **sink**.
+Pulsar IO connectors come in two types:
+
+- Source
Review Comment:
```suggestion
- [Source](#source)
```
##########
docs/io-use.md:
##########
@@ -105,21 +106,21 @@ configs:
tableName: "test_jdbc"
```
-## Get available connectors
+## Prepare a connector
Before starting using connectors, you can perform the following operations:
-* [Reload connectors](#reload)
+* [Reload connectors](#reload-connectors)
-* [Get a list of available connectors](#get-available-connectors)
+* [Get a list of available connectors](#get-a-list-of-available-connectors)
Review Comment:
```suggestion
* [Get a list of available connectors](#get-available-connectors)
```
##########
docs/io-develop.md:
##########
@@ -2,6 +2,7 @@
id: io-develop
title: How to develop Pulsar connectors
sidebar_label: "Develop"
+description: Get started to develop Pulsar connectors to move data between Pulsar and other systems.
Review Comment:
```suggestion
description: Learn how to develop Pulsar connectors to move data between Pulsar and other systems.
```
##########
docs/io-use.md:
##########
@@ -415,13 +416,13 @@ For the latest and complete information, see [Pulsar admin docs](pathname:///ref
</Tabs>
````
-### `localrun`
+### Run a connector locally
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -105,21 +106,21 @@ configs:
tableName: "test_jdbc"
```
-## Get available connectors
+## Prepare a connector
Before starting using connectors, you can perform the following operations:
-* [Reload connectors](#reload)
+* [Reload connectors](#reload-connectors)
Review Comment:
```suggestion
* [Reload connectors](#reload)
```
##########
docs/io-overview.md:
##########
@@ -26,17 +30,17 @@ This diagram illustrates the relationship between source, Pulsar, and sink:
### Source
-> Sources **feed data from external systems into Pulsar**.
+Source connectors **feed data from external systems into Pulsar**.
-Common sources include other messaging systems and firehose-style data pipeline APIs.
+Common source connectors include other messaging systems and firehose-style data pipeline APIs.
Review Comment:
```suggestion
Common sources include other messaging systems and firehose-style data pipeline APIs.
```
Here refers to "sources" rather than "connectors"
##########
docs/io-overview.md:
##########
@@ -52,13 +56,17 @@ Delivery semantic | Description
`at-least-once` | Each message sent to a connector is to be **processed once** or **more than once**.
`effectively-once` | Each message sent to a connector has **one output associated** with it.
-> Processing guarantees for connectors not just rely on Pulsar guarantee but also **relate to external systems**, that is, **the implementation of source and sink**.
+Processing guarantees for connectors not just rely on Pulsar guarantee but also **relate to external systems**, that is, **the implementation of source and sink**.
+
+* Source
+
+ Pulsar ensures that writing messages to Pulsar topics respects the processing guarantees. It is within Pulsar's control.
-* Source: Pulsar ensures that writing messages to Pulsar topics respects the processing guarantees. It is within Pulsar's control.
+* Sink
-* Sink: the processing guarantees rely on the sink implementation. If the sink implementation does not handle retries in an idempotent way, the sink does not respect the processing guarantees.
+ The processing guarantees rely on the sink implementation. If the sink implementation does not handle retries in an idempotent way, the sink does not respect the processing guarantees.
-### Set
+### How to set the processing guarantee
Review Comment:
```suggestion
### Set processing guarantees
```
Keep headings short
##########
docs/io-use.md:
##########
@@ -30,11 +31,11 @@ After the setup, the built-in connector is automatically discovered by Pulsar br
You can configure the following information:
-* [Configure a default storage location for a connector](#configure-a-default-storage-location-for-a-connector)
+* [Configure a default storage location for built-in connectors](#configure-a-default-storage-location-for-built-in-connectors)
Review Comment:
```suggestion
* [Configure a default storage location for a built-in connector](#configure-a-default-storage-location-for-a-built-in-connector)
```
##########
docs/io-use.md:
##########
@@ -161,19 +162,19 @@ pulsar-admin sinks available-sinks
To run a connector, you can perform the following operations:
-* [Create a connector](#create)
+* [Create a connector](#create-a-connector)
-* [Start a connector](#start)
+* [Start a connector](#start-a-connector)
-* [Run a connector locally](#localrun)
+* [Run a connector locally](#run-a-connector-locally)
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -341,13 +342,13 @@ Send a `POST` request to this endpoint: {@inject: endpoint|POST|/admin/v3/sinks/
</Tabs>
````
-### `start`
+### Start a connector
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -129,29 +130,29 @@ For the latest and complete information, see [Pulsar admin docs](pathname:///ref
#### Sink
-Use the `reload` subcommand.
+To reload sink connectors, you can use the `reload` subcommand.
```shell
pulsar-admin sinks reload
```
For the latest and complete information, see [Pulsar admin docs](pathname:///reference/#/@pulsar:version_reference@/pulsar-admin/).
-### `available`
+### Get a list of available connectors
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -478,19 +479,19 @@ For the latest and complete information, see [Pulsar admin sinks command docs](p
To monitor a connector, you can perform the following operations:
-* [Get the information of a connector](#get)
+* [Get the information of a connector](#get-the-information-of-a-connector)
-* [Get the list of all running connectors](#list)
+* [Get the list of all running connectors](#get-the-list-of-all-running-connectors)
-* [Get the current status of a connector](#status)
+* [Get the current status of a connector](#get-the-current-status-of-a-connector)
-### `get`
+### Get the information of a connector
Review Comment:
same as above
##########
docs/io-use.md:
##########
@@ -989,11 +990,11 @@ For the latest and complete information, see [Pulsar admin docs](pathname:///ref
### `update`
-You can update a running connector using **Admin CLI**, **REST API** or **JAVA admin API**.
+To update a running connector, You can use **Admin CLI**, **REST API** or **JAVA admin API**.
Review Comment:
Why capitalize "Y"?
--
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