Skip to content

Commit

Permalink
add matrix for reader and tableview
Browse files Browse the repository at this point in the history
  • Loading branch information
momo-jun committed Jun 26, 2023
1 parent 00b04ae commit b96ec22
Show file tree
Hide file tree
Showing 3 changed files with 309 additions and 52 deletions.
10 changes: 9 additions & 1 deletion client-feature-matrix/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ import {

<Matrix data={consumer} name="consumer" />

### Readerer

<Matrix data={reader} name="reader" />

### TableView

<Matrix data={tableview} name="tableview" />

<br />
<br />

See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
For how to update this page, see [Pulsar Contribution Guide](site-intro.md#how-to-update-data-driven-pages).
23 changes: 12 additions & 11 deletions contribute/document-contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ This <fix / improvment> is available for 2.8.2 and later versions.

If you want to update [Pulsar reference docs](pathname:///reference/), you should update the corresponding source files.

* Some reference docs are generated from code **automatically**. If you want to update the docs, you need to update the source code files.
* Some configuration docs are updated **manually** using markdown files.
- Some reference docs are generated from code **automatically**. If you want to update the docs, you need to update the source code files.
- Some configuration docs are updated **manually** using markdown files.

### Update configuration docs

Docs for configs of bundled components are generated from command-line tools **automatically**:

| Components | Update where ... |
|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Broker | [org.apache.pulsar.broker.ServiceConfiguration](https://github.com/apache/pulsar/blob/master/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java) |
| WebSocket | [org.apache.pulsar.websocket.service.WebSocketProxyConfiguration](https://github.com/apache/pulsar/blob/master/pulsar-websocket/src/main/java/org/apache/pulsar/websocket/service/WebSocketProxyConfiguration.java) |
| Proxy | [org.apache.pulsar.proxy.server.ProxyConfiguration](https://github.com/apache/pulsar/blob/master/pulsar-proxy/src/main/java/org/apache/pulsar/proxy/server/ProxyConfiguration.java) |
Expand All @@ -52,7 +52,7 @@ Docs for configs of bundled components are generated from command-line tools **a
Docs for configs of external components (whose source code is hosted outside the Pulsar repositories) are updated **manually**:

| Components | Update where ... |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| BookKeeper | [reference-configuration-bookkeeper.md](https://github.com/apache/pulsar-site/blob/main/static/reference/next/config/reference-configuration-bookkeeper.md) |
| Log4j | [reference-configuration-log4j.md](https://github.com/apache/pulsar-site/blob/main/static/reference/next/config/reference-configuration-log4j.md) |
| Log4j shell | [reference-configuration-log4j-shell.md](https://github.com/apache/pulsar-site/blob/main/static/reference/next/config/reference-configuration-log4j-shell.md) |
Expand All @@ -63,7 +63,7 @@ Docs for configs of external components (whose source code is hosted outside the
Docs for bundled Java-based command-line tools are generated **automatically**:

| Components | Update where… |
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pulsar | Different subcommands of [bin/pulsar](https://github.com/apache/pulsar/blob/master/bin/pulsar) are updated in different code files |
| pulsar-admin | [Classes under the admin command-line folder](https://github.com/apache/pulsar/tree/master/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli) |
| pulsar-client | [Classes under the client command-line folder](https://github.com/apache/pulsar/tree/master/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli) |
Expand All @@ -72,16 +72,17 @@ Docs for bundled Java-based command-line tools are generated **automatically**:
Docs for external command-line tools or bare scripts are updated **manually**:

| Components | Update where… |
|---------------|--------------------------------------------------------------------------------------------------------------------------|
| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
| pulsar-shell | [pulsar-shell.md](https://github.com/apache/pulsar-site/blob/main/static/reference/next/pulsar-shell/pulsar-shell.md) |
| pulsar-daemon | [pulsar-daemon.md](https://github.com/apache/pulsar-site/blob/main/static/reference/next/pulsar-daemon/pulsar-daemon.md) |
| bookkeeper | [bookkeeper.md](https://github.com/apache/pulsar-site/blob/main/static/reference/next/bookkeeper/bookkeeper.md) |

## Update feature matrix

Pulsar feature matrix introduces the features supported by language-specific clients and functions. It includes:
* [Client Feature Matrix](pathname:///client-feature-matrix)
* [Function Feature Matrix](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=328808194)

- [Client Feature Matrix](pathname:///client-feature-matrix)
- [Function Feature Matrix](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=328808194)

You need to update the feature matrix as soon as your related commits get merged. The workflow is illustrated as follows.

Expand All @@ -93,7 +94,7 @@ You need to update the feature matrix as soon as your related commits get merged

:::note

* [Client Feature Matrix](pathname:///client-feature-matrix) is in the transition phase from the spreadsheet to the webpage. For how to update it, see [How to update data-driven pages](site-intro.md#how-to-update-data-driven-pages).
* If you have problems in editing the spreadsheet of [Function Feature Matrix](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=328808194), you can reach out to `[email protected]`.
- For how to update the [Client Feature Matrix](pathname:///client-feature-matrix), see [How to update data-driven pages](site-intro.md#how-to-update-data-driven-pages).
- If you have problems in editing the spreadsheet of [Function Feature Matrix](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=328808194), you can reach out to `[email protected]`.

:::
:::
Loading

0 comments on commit b96ec22

Please sign in to comment.