Jennifer88huang commented on a change in pull request #7904: URL: https://github.com/apache/pulsar/pull/7904#discussion_r481639576
########## File path: site2/docs/functions-package.md ########## @@ -0,0 +1,524 @@ +--- +id: functions-package +title: Package Pulsar Functions +sidebar_label: "How-to: Package" +--- + +This section provides step-by-step instructions to package Pulsar functions in Java, Python, and Go. + +> **Tip** +> +> - Packaging a window function in Java is the same as [packaging a function in Java](#java) as below. +> +> - Currently, the window function is not available in Python and Go. + +## Prerequisite + +Before running a Pulsar function, you need to start Pulsar. + +### Run a standalone Pulsar in Docker + +This example uses Docker to run a standalone Pulsar. + +```bash +docker run -it \ + -p 6650:6650 \ + -p 8080:8080 \ + -v $PWD/data:/pulsar/data \ + apachepulsar/pulsar:latest \ + bin/pulsar standalone +``` + +> **Tip** +> +> - `$PWD/data` is the local directory. `-v` maps the `/pulsar/data` directory in the Docker image to the local `$PWD/data` directory. +> +> - To check whether the image starts up, use the command `docker ps`. + +### Run Pulsar cluster in k8s + +For details about how to deploy a Pulsar cluster in the k8s environment, For details, see [here](https://pulsar.apache.org/docs/en/helm-overview/). Review comment: use relative path for links, update it as (helm-overview.md) ########## File path: site2/docs/functions-package.md ########## @@ -0,0 +1,524 @@ +--- +id: functions-package +title: Package Pulsar Functions +sidebar_label: "How-to: Package" +--- + +This section provides step-by-step instructions to package Pulsar functions in Java, Python, and Go. + +> **Tip** +> +> - Packaging a window function in Java is the same as [packaging a function in Java](#java) as below. +> +> - Currently, the window function is not available in Python and Go. + +## Prerequisite + +Before running a Pulsar function, you need to start Pulsar. + +### Run a standalone Pulsar in Docker + +This example uses Docker to run a standalone Pulsar. + +```bash +docker run -it \ + -p 6650:6650 \ + -p 8080:8080 \ + -v $PWD/data:/pulsar/data \ + apachepulsar/pulsar:latest \ + bin/pulsar standalone +``` + +> **Tip** +> +> - `$PWD/data` is the local directory. `-v` maps the `/pulsar/data` directory in the Docker image to the local `$PWD/data` directory. +> +> - To check whether the image starts up, use the command `docker ps`. Review comment: what does "the image starts up"? ########## File path: site2/docs/functions-package.md ########## @@ -35,18 +35,18 @@ docker run -it \ > > - To check whether the image starts up or not, use the command `docker ps`. -## Run Pulsar cluster in k8s +### Run Pulsar cluster in k8s -For how to deploy Pulsar cluster in the k8s environment, please refer to [here](https://pulsar.apache.org/docs/en/helm-overview/). +For how to deploy Pulsar cluster in the k8s environment, For details, refer to [here](https://pulsar.apache.org/docs/en/helm-overview/). -# Java +## Java This example demonstrates how to package a function in Java. > **Note** > -> This example assumes that you have [run a standalone Pulsar in Docker](#Run Pulsar cluster in Docker) successfully. +> This example assumes that you have [run a standalone Pulsar in Docker](#Run a standalone Pulsar in Docker) successfully. Review comment: you can use "(#run-a-standalone-pulsar-in-docker)" for the link. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
