You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/11/01 11:45:21 UTC
[GitHub] [pulsar] x-shadow-man opened a new pull request #12567: doc optimization
x-shadow-man opened a new pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567
<!--
### Contribution Checklist
- Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
Skip *Issue XYZ* if there is no associated github issue for this pull request.
Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
Fixes #<xyz>
*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
Master Issue: #<xyz>
### Motivation
*Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
### Modifications
*Describe the modifications you've done.*
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (10MB)*
- *Extended integration test for recovery after broker failure*
### Does this pull request potentially affect one of the following parts:
*If `yes` was chosen, please highlight the changes*
- Dependencies (does it add or upgrade a dependency): (yes / no)
- The public API: (yes / no)
- The schema: (yes / no / don't know)
- The default values of configurations: (yes / no)
- The wire protocol: (yes / no)
- The rest endpoints: (yes / no)
- The admin cli options: (yes / no)
- Anything that affects deployment: (yes / no / don't know)
### Documentation
Check the box below and label this PR (if you have committer privilege).
Need to update docs?
- [ ] `doc-required`
(If you need help on updating docs, create a doc issue)
- [ ] `no-need-doc`
(Please explain why)
- [ ] `doc`
(If this PR contains doc changes)
--
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] x-shadow-man commented on pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
x-shadow-man commented on pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#issuecomment-958930821
@frankxieke buddy, can u feel free to check the doc? thx. :-)
--
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] Anonymitaet commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r740935005
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
@frankxieke can you review it from the technical perspective? 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] Anonymitaet commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r740935005
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
@frankxieke can you review it from the technical perspective? 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] x-shadow-man commented on pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
x-shadow-man commented on pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#issuecomment-958930821
--
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] frankxieke commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
frankxieke commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r743360581
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
There is some misunderstanding here.
I think the original doc meaning is "this command can be run on any machine, and the zookeeper argument can be any machine of Zookeeper cluster", because one of the argument of the following command is zookeeper address.
--
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] codelipenghui merged pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
codelipenghui merged pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567
--
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] frankxieke commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
frankxieke commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r743359429
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
I think the original doc meaning is "this command can be run on any machine of ZooKeeper cluster", because one of the argument of the following command is zookeeper address.
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
There is some misunderstanding here.
I think the original doc meaning is "this command can be run on any machine, and the zookeeper argument can be any machine of Zookeeper cluster", because one of the argument of the following command is zookeeper address.
--
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] x-shadow-man commented on pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
x-shadow-man commented on pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#issuecomment-958930821
@frankxieke buddy, can u feel free to check the doc? thx. :-)
--
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] github-actions[bot] commented on pull request #12567: doc optimization
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#issuecomment-956164742
@x-shadow-man:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? 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] Anonymitaet commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r740935005
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
@frankxieke can you review it from the technical perspective? 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] frankxieke commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
frankxieke commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r743359429
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
I think the original doc meaning is "this command can be run on any machine of ZooKeeper cluster", because one of the argument of the following command is zookeeper address.
--
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] frankxieke commented on a change in pull request #12567: doc optimization for issue #12488
Posted by GitBox <gi...@apache.org>.
frankxieke commented on a change in pull request #12567:
URL: https://github.com/apache/pulsar/pull/12567#discussion_r743359429
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
I think the original doc meaning is "this command can be run on any machine of ZooKeeper cluster", because one of the argument of the following command is zookeeper address.
##########
File path: site2/website-next/versioned_docs/version-2.7.3/deploy-bare-metal.md
##########
@@ -243,7 +243,7 @@ $ PULSAR_EXTRA_OPTS="-Dstats_server_port=8001" bin/pulsar-daemon start zookeeper
Once you deploy ZooKeeper for your cluster, you need to write some metadata to ZooKeeper for each cluster in your instance. You only need to write this data **once**.
-You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your ZooKeeper cluster. The following is an example:
+You can initialize this metadata using the [`initialize-cluster-metadata`](reference-cli-tools.md#pulsar-initialize-cluster-metadata) command of the [`pulsar`](reference-cli-tools.md#pulsar) CLI tool. This command can be run on any machine in your Pulsar, so metadata can be initialized from a ZooKeeper, Broker, or Bookie machine. The following is an example:
Review comment:
There is some misunderstanding here.
I think the original doc meaning is "this command can be run on any machine, and the zookeeper argument can be any machine of Zookeeper cluster", because one of the argument of the following command is zookeeper address.
--
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