Skip to content

Commit

Permalink
fix: some docs issues (apache#12845)
Browse files Browse the repository at this point in the history
* fix: some docs issues

Signed-off-by: LiLi <[email protected]>

* patch

Signed-off-by: LiLi <[email protected]>

* patch

Signed-off-by: LiLi <[email protected]>
  • Loading branch information
urfreespace authored Nov 17, 2021
1 parent f68bec4 commit 099c958
Show file tree
Hide file tree
Showing 863 changed files with 12,518 additions and 16,976 deletions.
4 changes: 0 additions & 4 deletions site2/website-next/docs/adaptors-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: Pulsar adaptor for Apache Kafka
sidebar_label: "Kafka client wrapper"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';



Pulsar provides an easy option for applications that are currently written using the [Apache Kafka](http://kafka.apache.org) Java client API.

Expand Down
4 changes: 0 additions & 4 deletions site2/website-next/docs/adaptors-spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: Pulsar adaptor for Apache Spark
sidebar_label: "Apache Spark"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


## Spark Streaming receiver
The Spark Streaming receiver for Pulsar is a custom receiver that enables Apache [Spark Streaming](https://spark.apache.org/streaming/) to receive raw data from Pulsar.

Expand Down
4 changes: 0 additions & 4 deletions site2/website-next/docs/adaptors-storm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: Pulsar adaptor for Apache Storm
sidebar_label: "Apache Storm"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


Pulsar Storm is an adaptor for integrating with [Apache Storm](http://storm.apache.org/) topologies. It provides core Storm implementations for sending and receiving data.

An application can inject data into a Storm topology via a generic Pulsar spout, as well as consume data from a Storm topology via a generic Pulsar bolt.
Expand Down
90 changes: 6 additions & 84 deletions site2/website-next/docs/admin-api-brokers.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,7 @@ Fetch all available active brokers that are serving traffic.

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

```shell
Expand Down Expand Up @@ -93,20 +80,7 @@ Fetch the information of the leader broker, for example, the service url.

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

```shell
Expand Down Expand Up @@ -147,20 +121,7 @@ It finds all namespaces which are owned and served by a given broker.

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

```shell
Expand Down Expand Up @@ -213,20 +174,7 @@ But since all broker configuration in Pulsar is stored in ZooKeeper, configurati

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

The [`update-dynamic-config`](reference-pulsar-admin.md#brokers-update-dynamic-config) subcommand will update existing configuration. It takes two arguments: the name of the parameter and the new value using the `config` and `value` flag respectively. Here's an example for the [`brokerShutdownTimeoutMs`](reference-configuration.md#broker-brokerShutdownTimeoutMs) parameter:
Expand Down Expand Up @@ -260,20 +208,7 @@ admin.brokers().updateDynamicConfiguration(configName, configValue);
Fetch a list of all potentially updatable configuration parameters.
<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

```shell
Expand Down Expand Up @@ -307,20 +242,7 @@ Fetch a list of all parameters that have been dynamically updated.

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

```shell
Expand Down
90 changes: 6 additions & 84 deletions site2/website-next/docs/admin-api-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,7 @@ New clusters can be provisioned using the admin interface.
<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

You can provision a new cluster using the [`create`](reference-pulsar-admin.md#clusters-create) subcommand. Here's an example:
Expand Down Expand Up @@ -129,20 +116,7 @@ You can fetch the [configuration](reference-configuration) for an existing clust

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

Use the [`get`](reference-pulsar-admin.md#clusters-get) subcommand and specify the name of the cluster. Here's an example:
Expand Down Expand Up @@ -184,20 +158,7 @@ You can update the configuration for an existing cluster at any time.

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

Use the [`update`](reference-pulsar-admin.md#clusters-update) subcommand and specify new configuration values using flags.
Expand Down Expand Up @@ -240,20 +201,7 @@ Clusters can be deleted from a Pulsar [instance](reference-terminology.md#instan

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

Use the [`delete`](reference-pulsar-admin.md#clusters-delete) subcommand and specify the name of the cluster.
Expand Down Expand Up @@ -288,20 +236,7 @@ You can fetch a list of all clusters in a Pulsar [instance](reference-terminolog

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

Use the [`list`](reference-pulsar-admin.md#clusters-list) subcommand.
Expand Down Expand Up @@ -338,20 +273,7 @@ Peer clusters can be configured for a given cluster in a Pulsar [instance](refer

<Tabs
defaultValue="pulsar-admin"
values={[
{
"label": "pulsar-admin",
"value": "pulsar-admin"
},
{
"label": "REST API",
"value": "REST API"
},
{
"label": "JAVA",
"value": "JAVA"
}
]}>
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST API","value":"REST API"},{"label":"JAVA","value":"JAVA"}]}>
<TabItem value="pulsar-admin">

Use the [`update-peer-clusters`](reference-pulsar-admin.md#clusters-update-peer-clusters) subcommand and specify the list of peer-cluster names.
Expand Down
Loading

0 comments on commit 099c958

Please sign in to comment.