Skip to content

Commit

Permalink
[improve][docs] Get started locally (#17475)
Browse files Browse the repository at this point in the history
  • Loading branch information
tisonkun authored Sep 7, 2022
1 parent 757035b commit ae7c941
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 220 deletions.
6 changes: 3 additions & 3 deletions site2/docs/getting-started-docker.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: getting-started-docker
title: Set up a standalone Pulsar in Docker
title: Run a standalone Pulsar cluster in Docker
sidebar_label: "Run Pulsar in Docker"
---

For local development and testing, you can run Pulsar in standalone mode on your own machine within a Docker container.
For local development and testing, you can run Pulsar in standalone mode on your own machine within a Docker container.

If you have not installed Docker, download the [Community edition](https://www.docker.com/community-edition) and follow the instructions for your OS.

Expand Down Expand Up @@ -48,7 +48,7 @@ After starting Pulsar successfully, you can see `INFO`-level log messages like t

## Use Pulsar in Docker

Pulsar offers a variety of [client libraries](client-libraries.md), such as [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md), [C++](client-libraries-cpp.md).
Pulsar offers a variety of [client libraries](client-libraries.md), such as [Java](client-libraries-java.md), [Go](client-libraries-go.md), [Python](client-libraries-python.md), [C++](client-libraries-cpp.md).

If you're running a local standalone cluster, you can use one of these root URLs to interact with your cluster:
* `pulsar://localhost:6650`
Expand Down
14 changes: 7 additions & 7 deletions site2/docs/getting-started-helm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getting-started-helm
title: Get started in Kubernetes
title: Run a standalone Pulsar cluster in Kubernetes
sidebar_label: "Run Pulsar in Kubernetes"
---

Expand Down Expand Up @@ -52,7 +52,7 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start
minikube dashboard
```

The command automatically triggers opening a webpage in your browser.
The command automatically triggers opening a webpage in your browser.

## Step 1: Install Pulsar Helm chart

Expand Down Expand Up @@ -88,7 +88,7 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start
-c
```

4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes.
4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes.

```bash
helm install \
Expand Down Expand Up @@ -169,7 +169,7 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start
bin/pulsar-admin tenants list
```

You should see a similar output as below. The tenant `apache` has been successfully created.
You should see a similar output as below. The tenant `apache` has been successfully created.

```bash
"apache"
Expand All @@ -189,7 +189,7 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/) in this quick start
bin/pulsar-admin namespaces list apache
```

You should see a similar output as below. The namespace `apache/pulsar` has been successfully created.
You should see a similar output as below. The namespace `apache/pulsar` has been successfully created.

```bash
"apache/pulsar"
Expand Down Expand Up @@ -303,7 +303,7 @@ Then you can proceed with the following steps:
- From the producer side

**Output**

The messages have been produced successfully.

```bash
Expand Down Expand Up @@ -351,7 +351,7 @@ Then you can proceed with the following steps:

2. The Pulsar Manager UI will be open in your browser. You can use the username `pulsar` and password `pulsar` to log into Pulsar Manager.

3. In Pulsar Manager UI, you can create an environment.
3. In Pulsar Manager UI, you can create an environment.

- Click **New Environment** in the upper-left corner.
- Type `pulsar-mini` for the field `Environment Name` in the pop-up window.
Expand Down
8 changes: 4 additions & 4 deletions site2/docs/getting-started-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Get started
sidebar_label: "Get Started"
---

Getting up and running with Pulsar is simple. Download it, install it, and try it out.
Getting up and running with Pulsar is simple. Download it, install it, and try it out.

You have three options. Click any of these links to begin your Pulsar journey!
* [Run a standalone Pulsar locally](getting-started-standalone.md) - Run a single instance of Pulsar in standalone mode on a single machine.
* [Run a standalone Pulsar in Docker](getting-started-docker.md) - Run one or more instances of Pulsar in a Docker container.
* [Run a standalone Pulsar in Kubernetes](getting-started-helm.md) - Run one or more instances of Pulsar in Kubernetes using a Helm chart.
* [Run a standalone Pulsar cluster locally](getting-started-standalone.md) - Run a single instance of Pulsar in standalone mode on a single machine.
* [Run a standalone Pulsar cluster in Docker](getting-started-docker.md) - Run one or more instances of Pulsar in a Docker container.
* [Run a standalone Pulsar cluster in Kubernetes](getting-started-helm.md) - Run one or more instances of Pulsar in Kubernetes using a Helm chart.
Loading

0 comments on commit ae7c941

Please sign in to comment.