You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "urfreespace (via GitHub)" <gi...@apache.org> on 2023/04/12 06:35:18 UTC
[GitHub] [pulsar-site] urfreespace opened a new pull request, #513: matrix page
urfreespace opened a new pull request, #513:
URL: https://github.com/apache/pulsar-site/pull/513
issue: https://github.com/apache/pulsar/issues/17098
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `./preview.sh` at root path) to your PR description, or else your PR might not get merged. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [x] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178839663
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
Maybe I didn't make it clear. In this PR, we only add the matrix for Client, Producer, and Consumer. With more feedback/voice from the community, we will iterate and continue to add the matrix for Reader and TableView. After that, we can remove 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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178772326
##########
docusaurus.config.js:
##########
@@ -393,6 +393,16 @@ module.exports = {
sidebarPath: false,
}),
],
+ [
+ "content-docs",
Review Comment:
If it's a standalone page, we may not need a docs plugin instance.
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
After we land this page, shall this page be the source of truth so that we don't refer to the gdoc? Otherwise, why do we add such a page?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178827357
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
Weird. Then we create two similar but different matrices, which seems not a good idea.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178823054
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
Yes, it should be the source of truth. However, the page is a compact version at the pilot stage.
In case some users or maitainers still need more information from the working sheet, we attach the link here to not lose the connection with the full version.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] urfreespace commented on pull request #513: pulsar client matrix page
Posted by "urfreespace (via GitHub)" <gi...@apache.org>.
urfreespace commented on PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#issuecomment-1522982248
<img width="884" alt="image" src="https://user-images.githubusercontent.com/76024046/234513593-2ab79636-5707-4647-98b5-f6951c845dd5.png">
Hi, @tisonkun would you pls help take a look at this CI problem? thanks very much
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178916394
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
```suggestion
See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing).
```
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178829914
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
For example, I'm a developer, I cannot trust the page but have to look at the gdoc version because any updates will go there first. As a user, it's the same. This patch introduces a _maybe_ up-to-date version but any updates and nightly changes happen on the gdoc. Then I suggest we use only the gdoc and that should not worse the case.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178839663
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
Maybe I didn't make it clear. In this PR, we only add the matrix for Client, Producer, and Consumer. With more feedback/voice from the community, we will iterate and continue to add the matrix for Reader and TableView. After that, we can move 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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] urfreespace commented on pull request #513: matrix page
Posted by "urfreespace (via GitHub)" <gi...@apache.org>.
urfreespace commented on PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#issuecomment-1522960897
> Thanks Lili. Add a few questions:
>
> 1. How to maintain the status in these tables? We need a user-friendly way so that maintainers can update the table on a regular basis.
> 2. Can we fold each table? Or add hot links on the right side so that users can read the whole page at a glance.
> 3. Can we add a scroll bar horizontally and vertically? Now the consumer matrix cannot be displayed in one screen, so we may lose the table header when looking at the bottom row.
>
> BTW, We plan to add reader/tableview in the next delivery phase and can add them when iterating the matrix.
done, PTAL, thanks @momo-jun
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun merged pull request #513: [feat] Add client matrix page
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun merged PR #513:
URL: https://github.com/apache/pulsar-site/pull/513
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] urfreespace commented on pull request #513: pulsar client matrix page
Posted by "urfreespace (via GitHub)" <gi...@apache.org>.
urfreespace commented on PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#issuecomment-1523322397
> @urfreespace fixed. It's because we now check-in yarn.lock to leverage yarn 3 pkg manager.
thanks
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] urfreespace commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "urfreespace (via GitHub)" <gi...@apache.org>.
urfreespace commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1179918906
##########
docusaurus.config.js:
##########
@@ -393,6 +393,16 @@ module.exports = {
sidebarPath: false,
}),
],
+ [
+ "content-docs",
Review Comment:
it's a simplified way to implement the below effect (the absolute same TOC effect with the docs page)
<img width="156" alt="image" src="https://user-images.githubusercontent.com/76024046/235055009-3c5a529b-1463-42c0-ad38-0605b597694d.png">
@tisonkun
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1179927807
##########
docusaurus.config.js:
##########
@@ -393,6 +393,16 @@ module.exports = {
sidebarPath: false,
}),
],
+ [
+ "content-docs",
Review Comment:
Thanks for your explanation! I agree with this trade-off now :D
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on pull request #513: matrix page
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#issuecomment-1509422602
Thanks Lili. Add a few questions:
1. How to maintain the status in these tables? We need a user-friendly way so that maintainers can update the table on a regular basis.
2. Can we fold each table? Or add hot links on the right side so that users can read the whole page at a glance.
3. Can we add a scroll bar horizontally and vertically? Now the consumer matrix cannot be displayed in one screen, so we may lose the table header when looking at the bottom row.
BTW, We plan to add reader/tableview in the next delivery phase and can add them when iterating the matrix.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #513: [feat] Add client matrix page
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#discussion_r1178846363
##########
client-feature-matrix/index.mdx:
##########
@@ -0,0 +1,29 @@
+---
+id: pulsar-client-feaure-matrix
+title: Pulsar Client Feaure Matrix
+sidebar_label: Pulsar Client Feaure Matrix
+---
+
+import Matrix from "../src/components/Matrix/matrix";
+import {
+ languages,
+ client,
+ producer,
+ reader,
+ consumer,
+ tableview,
+} from "../data/matrix.js";
+
+### Client
+
+<Matrix data={client} name="client" />
+
+### Producer
+
+<Matrix data={producer} name="producer" />
+
+### Consumer
+
+<Matrix data={consumer} name="consumer" />
+
+See details and full version [here](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit?usp=sharing)
Review Comment:
Thanks for your explanation! I'd prefer to remove the link so that it's clear that we'd like to move to this page. Instead of leaving a workaround and it's highly possible the intermediate situation remains for a long time.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on pull request #513: pulsar client matrix page
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on PR #513:
URL: https://github.com/apache/pulsar-site/pull/513#issuecomment-1523220118
@urfreespace fixed. It's because we now check-in yarn.lock to leverage yarn 3 pkg manager.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org