-
Notifications
You must be signed in to change notification settings - Fork 3.7k
[Doc][Improve] Add landing pages #18379
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
ba2ae16
[Doc][Improve] Add landing pages
DaveDuggins af8ba62
Add tutorial pages
DaveDuggins 1f378a1
Merge branch 'apache:master' into master
DaveDuggins 587b1d5
Update site2/docs/about.md
DaveDuggins 73a9fa2
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins 9fc4de7
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins b43598f
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins 7dfdb46
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins 02dcbdd
Update site2/docs/tutorials-tenant.md
DaveDuggins 9736d9d
Update developers-landing.md
DaveDuggins be1d9cc
Merge branch 'master' of https://github.com/DaveDuggins/pulsar
DaveDuggins 95bbb02
Create tutorials-produce-consume.md
DaveDuggins 982c0c8
Update site2/docs/tutorials-tenant.md
DaveDuggins 10724b8
Update site2/docs/tutorials-tenant.md
DaveDuggins 3653e12
Update site2/docs/tutorials-tenant.md
DaveDuggins 72d9cb0
Merge branch 'apache:master' into master
DaveDuggins b72b624
Delete developer-landing.md
DaveDuggins 53eedd8
Update site2/docs/tutorials-tenant.md
DaveDuggins cb94c02
Update install-deploy-upgrade-landing.md
DaveDuggins 62bdfae
Merge branch 'master' of https://github.com/DaveDuggins/pulsar
DaveDuggins 079699e
Update site2/docs/tutorials-topic.md
DaveDuggins e4994f9
Update site2/docs/tutorials-produce-consume.md
DaveDuggins 9ab447a
Update site2/docs/tutorials-produce-consume.md
DaveDuggins ba03b8c
Update site2/docs/tutorials-topic.md
DaveDuggins e7ea050
Typo
DaveDuggins 4ab3ae7
Update site2/docs/tutorials-tenant.md
DaveDuggins 9a37e00
Update site2/docs/tutorials-produce-consume.md
DaveDuggins d439f4a
Update site2/docs/tutorials-produce-consume.md
DaveDuggins eb3b811
Update site2/docs/tutorials-produce-consume.md
DaveDuggins 5e5ba80
Update site2/docs/tutorials-namespace.md
DaveDuggins e9ea087
Update site2/docs/install-deploy-upgrade-landing.md
DaveDuggins 1bf6473
Update site2/docs/how-to-landing.md
DaveDuggins 6df9fdf
Merge branch 'apache:master' into master
DaveDuggins fd0f366
fix link and style issues
momo-jun 33e1ea2
Merge branch 'apache:master' into master
DaveDuggins File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| --- | ||
| id: developers-landing | ||
| title: Pulsar for Developers | ||
| sidebar_label: "get started" | ||
| sidebar_label: "Pulsar for Developers" | ||
| --- | ||
|
|
||
| Developing applications for Pulsar can be a fun and rewarding experience. With Pulsar, you can quickly create, deploy, and manage your services using a powerful CLI tool and a comprehensive set of libraries. The topics below will get you started! | ||
|
|
||
| - [Simulation tools](develop-tools.md) | ||
| - [Developing binary protocol](developing-binary-protocol.md) | ||
| - [Modular load manager](develop-load-manager.md) | ||
| - [Pulsar plugin development](develop-plugin.md) | ||
| - [Develop simulation tools](develop-tools.md) | ||
| - [Develop binary protocol](developing-binary-protocol.md) | ||
| - [Develop load manager](develop-load-manager.md) | ||
| - [Develop Pulsar plugin](develop-plugin.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| Id: how-to-landing | ||
| title: How-to | ||
|
DaveDuggins marked this conversation as resolved.
|
||
| sidebar_label: “” | ||
|
DaveDuggins marked this conversation as resolved.
|
||
| --- | ||
|
|
||
|
|
||
| Learning new software can be an overwhelming task, but relax – most aspects of Pulsar can be easily configured in just a few steps. These tutorials will show you how to quickly create topics, tenants, and namespaces, produce and consume messages, and more! | ||
|
DaveDuggins marked this conversation as resolved.
|
||
|
|
||
| - [How to create a topic](tutorials-topic.md) | ||
| - [How to create a tenant](tutorials-tenant.md) | ||
| - [How to create a namespace](tutorials-namespace.md) | ||
| - [How to produce and consume messages](tutorials-produce-consume.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| Id: install-deploy-upgrade-landing | ||
| title: Install, Deploy and Upgrade Pulsar | ||
| sidebar_label: “Tutorials” | ||
| --- | ||
|
|
||
|
|
||
| Any developer can install, deploy, and upgrade Apache Pulsar in a few simple steps and start building scalable, real-time applications quickly. The resources below will kickstart your deployment! | ||
|
|
||
| - [Set up a standalone Pulsar locally](getting-started-standalone.md) | ||
|
|
||
| - [Deploy a Pulsar cluster on AWS using Terraform and Ansible](deploy-aws.md) | ||
|
|
||
| - [Deploy a Pulsar cluster using Helm](helm-deploy.md) | ||
|
|
||
| - [Upgrade Pulsar Helm release](helm-upgrade.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| Id: tutorials-namespace | ||
| title: How to create a namespace | ||
| sidebar_label: “Tutorials” | ||
| --- | ||
|
|
||
|
|
||
| Pulsar namespaces are logical groupings of topics. | ||
|
|
||
| Namespaces can be managed via: | ||
|
|
||
| - The namespaces command of the pulsar-admin tool | ||
| - The /admin/v2/namespaces endpoint of the admin {@inject: rest:REST:/} API | ||
| - The namespaces method of the PulsarAdmin object in the Java API | ||
|
|
||
| In this tutorial, we create a namespace called pulsar in the tenant apache. Then we list namespaces of tenant apache to see if the namespace is created successfully. | ||
|
|
||
| Create the namespace. | ||
|
|
||
| ```bash | ||
| bin/pulsar-admin namespaces create apache/pulsar | ||
| ``` | ||
|
|
||
| Verify the namespace. | ||
|
|
||
| ```bash | ||
| bin/pulsar-admin namespaces list apache | ||
| ``` | ||
|
|
||
| You should see similar output to show the namespace apache/pulsar has been successfully created. | ||
|
|
||
| #### Related Topics | ||
|
|
||
| - [Set up a tenant](tutorials-tenant.md) | ||
| - [Create a topic](tutorials-topic.md) | ||
| - [Produce and consume messages](tutorials-produce-consume.md) | ||
| - [Manage clusters](admin-api-clusters.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| Id: tutorials-produce-consume | ||
| title: Produce and consume messages | ||
| sidebar_label: “Tutorials” | ||
| --- | ||
|
|
||
| In this tutorial, we will: | ||
| - Configure the Pulsar client | ||
| - Create a subscription | ||
| - Create a producer | ||
| - Send test messages | ||
| - Verify the results | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Create tenant](tutorials-tenant.md) | ||
| - [Create namespace](tutorials-namespace.md) | ||
| - [Create topic](tutorials-topic.md) | ||
|
|
||
| ## Produce and consume messages | ||
|
|
||
| 1. In the `${PULSAR_HOME}/conf/client.conf` file, replace `webServiceUrl` and `brokerServiceUrl` with your service URL. | ||
|
|
||
| 2. Create a subscription to consume messages from `apache/pulsar/test-topic`. | ||
|
|
||
| ```bash | ||
| bin/pulsar-client consume -s sub apache/pulsar/test-topic -n 0 | ||
| ``` | ||
|
|
||
| 3. In a new terminal, create a producer and send 10 messages to test-topic. | ||
|
|
||
| ```bash | ||
| bin/pulsar-client produce apache/pulsar/test-topic -m "---------hello apache pulsar-------" -n 10 | ||
| ``` | ||
|
|
||
| 4. Verify the results. | ||
|
|
||
| ``` | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
| ----- got message ----- | ||
| ---------hello apache pulsar------- | ||
|
|
||
| Output from the producer side shows the messages have been produced successfully: | ||
| 18:15:15.489 [main] INFO org.apache.pulsar.client.cli.PulsarClientTool - 10 messages successfully produced. | ||
| ``` | ||
|
|
||
| #### Related Topics | ||
| - [Set up a tenant](tutorials-tenant.md) | ||
| - [Create a topic](tutorials-topic.md) | ||
| - [Create a namespace](tutorials-namespace.md) | ||
| - [Manage clusters](admin-api-clusters.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| Id: tutorials-tenant | ||
| title: How to set up a tenant | ||
| sidebar_label: “Tutorials” | ||
| --- | ||
|
|
||
|
|
||
| Pulsar is a powerful messaging system you can use to process and route high volumes of data. Each tenant provides a distinct unit of isolation with its own set of roles, permissions, configuration settings, and bookmarks. | ||
|
|
||
| In this tutorial, you will create a new tenant, named “apache” in your Pulsar cluster, hosted in K8s helm. | ||
|
|
||
| To create a tenant: | ||
|
|
||
| 1. Enter the toolset container. | ||
|
|
||
| ```bash | ||
| kubectl exec -it -n pulsar pulsar-mini-toolset-0 -- /bin/bash | ||
| ``` | ||
|
|
||
| 2. In the toolset container, create a tenant named apache. | ||
|
|
||
| ```bash | ||
| bin/pulsar-admin tenants create apache | ||
| ``` | ||
|
|
||
| 3. List the tenants to see if the tenant is created successfully. | ||
|
|
||
| ```bash | ||
| bin/pulsar-admin tenants list | ||
| ``` | ||
|
|
||
| You should see a similar output as below. | ||
|
|
||
| ``` | ||
| The tenant apache has been successfully created. | ||
| "apache" | ||
| "public" | ||
| "pulsar" | ||
| ``` | ||
|
|
||
| #### Related Topics | ||
|
|
||
| - [How to create a namespace](tutorials-namespace.md) | ||
| - [How to create a topic](tutorials-topic.md) | ||
| - [Run a standalone cluster in Kubernetes](getting-started-helm.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| Id: tutorials-topic | ||
| title: How to create a topic | ||
| sidebar_label: “Tutorials” | ||
|
DaveDuggins marked this conversation as resolved.
|
||
| --- | ||
|
|
||
|
|
||
| Apache Pulsar is a distributed messaging system that supports high performance and low latency. Topics are the primary way to structure data in Apache Pulsar. A Pulsar topic is a unit of storage that organizes messages into a stream. Each message in a topic has an offset, which uniquely identifies the message within the topic. | ||
|
|
||
| ## Prerequisites | ||
| [Publish to partitioned topics](admin-api-topics.md#publish-to-partitioned-topics) | ||
|
|
||
| ## Create a topic | ||
|
|
||
| 1. Create `test-topic` with 4 partitions in the namespace `apache/pulsar`. | ||
|
|
||
| ```bash | ||
| bin/pulsar-admin topics create-partitioned-topic apache/pulsar/test-topic -p 4 | ||
| ``` | ||
|
|
||
| 2. List all the partitioned topics in the namespace `apache/pulsar`. | ||
|
|
||
| ```bash | ||
| bin/pulsar-admin topics list-partitioned-topics apache/pulsar | ||
| ``` | ||
|
|
||
| #### Related Topics | ||
|
|
||
| - [How to set up a tenant](tutorials-tenant.md) | ||
| - [How to create a namespace](tutorials-namespace.md) | ||
| - [How to produce and consume messages](tutorial-produce-consume.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.