You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/06/21 17:19:26 UTC

[GitHub] [pulsar] D-2-Ed opened a new pull request, #16164: Update functions-overview.md

D-2-Ed opened a new pull request, #16164:
URL: https://github.com/apache/pulsar/pull/16164

   This is a doc-only update - doc cleanup without any test coverage.
   
   Removed redundancy and wordiness, fixed some minor grammar issues, and added a bit more context.
   
   ### Documentation
   
   Check the box below or label this PR directly.
   
   Need to update docs? 
   
   - [ ] `doc-required` 
   (Your PR needs to update docs and you will update later)
     
   - [ ] `doc-not-needed` 
   (Please explain why)
     
   - [x] `doc` 
   (Your PR contains doc changes)
   
   - [ ] `doc-complete`
   (Docs have been already added)


-- 
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] Anonymitaet commented on a diff in pull request #16164: Update functions-overview.md

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16164:
URL: https://github.com/apache/pulsar/pull/16164#discussion_r904469215


##########
site2/docs/functions-overview.md:
##########
@@ -5,30 +5,26 @@ sidebar_label: "Overview"
 ---
 
 This section introduces the following content:
-* [What is Pulsar Functions](#what-is-pulsar-functions)
+* [What are Pulsar Functions](#what-is-pulsar-functions)

Review Comment:
   ```suggestion
   * [What are Pulsar Functions](#16181 -pulsar-functions)
   ```
   Do not forget to update all occurrences where reference `[What is Pulsar Functions](#what-is-pulsar-function)` to `[What are Pulsar Functions](#what-is-pulsar-functions)` in the whole Pulsar doc repo.



##########
site2/docs/functions-overview.md:
##########
@@ -5,30 +5,26 @@ sidebar_label: "Overview"
 ---
 
 This section introduces the following content:
-* [What is Pulsar Functions](#what-is-pulsar-functions)
+* [What are Pulsar Functions](#what-is-pulsar-functions)
 * [Why use Puslar Functions](#why-use-pulsar-functions)
 * [Use cases](#use-cases)
 * [User flow](#user-flow)
 
 
 ## What are Pulsar Functions
+Pulsar functions are a serverless computing framework that runs on top of Pulsar. You can use this simple API and execution framework to implement common use cases, such as filtering and routing. Once you write a Pulsar function and submit it to the Pulsar cluster, it is up and running immediately.
 
-Pulsar Functions are a serverless computing framework that runs on top of Pulsar and processes messages in the following way:
-* consumes messages from one or more topics,
-* applies a user-defined processing logic to the messages,
-* publishes the outputs of the messages to other topics.
-
-The following figure illustrates the computing process of a function. 
+The diagram below illustrates the three steps in the functions computing process. 
 
 ![Pulsar Functions execute user-defined code on data published to Pulsar topics](/assets/function-overview.svg)
 
-A function receives messages from one or more **input topics**. Each time messages are received, the function completes the following steps:
-1. Consumes the messages in the input topics.
-2. Applies a customized processing logic to the messages and:
-    a) writes output messages to an **output topic** in Pulsar
-    b) writes logs to a **log topic** if it is configured (for debugging purposes)
-    c) writes [state](functions-develop-state) to BookKeeper (if it is configured) 
-
+Each time a function receives a message, it completes the following consume-apply-publish steps.
+1. Consumes the message from one or more **input topics**. 
+2. Applies the customized (user-supplied) processing logic to the message.
+3. Publishes the output of the message to other topics and writes:
+    a) output messages to an **output topic** in Pulsar
+    b) logs to a **log topic** (if it is configured)for debugging
+    c) [state](functions-develop-state) updates to BookKeeper (if it is configured) 

Review Comment:
   Thanks for your contribution!
   
   1. Before submitting a doc PR, please [preview your changes locally](https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#). When submitting a PR, please attach the screenshots of your local preview. In this way, you can get your PR reviewed and merged more quickly.
   
   2. Does this change apply to multiple doc versions? If so, please [update them all](https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs).
   
   Thank you! 😊



-- 
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] github-actions[bot] commented on pull request #16164: Update functions-overview.md

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #16164:
URL: https://github.com/apache/pulsar/pull/16164#issuecomment-1193229646

   The pr had no activity for 30 days, mark with Stale label.


-- 
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] tisonkun closed pull request #16164: Update functions-overview.md

Posted by GitBox <gi...@apache.org>.
tisonkun closed pull request #16164: Update functions-overview.md
URL: https://github.com/apache/pulsar/pull/16164


-- 
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] Anonymitaet commented on a diff in pull request #16164: Update functions-overview.md

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16164:
URL: https://github.com/apache/pulsar/pull/16164#discussion_r904469215


##########
site2/docs/functions-overview.md:
##########
@@ -5,30 +5,26 @@ sidebar_label: "Overview"
 ---
 
 This section introduces the following content:
-* [What is Pulsar Functions](#what-is-pulsar-functions)
+* [What are Pulsar Functions](#what-is-pulsar-functions)

Review Comment:
   
   Do not forget to update all occurrences where reference `[What is Pulsar Functions](#what-is-pulsar-function)` to `[What are Pulsar Functions](#what-is-pulsar-functions)` in the whole Pulsar doc repo.



-- 
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] tisonkun commented on pull request #16164: Update functions-overview.md

Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #16164:
URL: https://github.com/apache/pulsar/pull/16164#issuecomment-1313141897

   Closed as stale and conflicts.
   
   If it's still relevant, please resubmit the patch :)


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