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/08/01 09:54:39 UTC
[GitHub] [pulsar] vsly-ru opened a new pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
vsly-ru opened a new pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526
Added topic's name format and examples to specify a tenant and namespace of the topic.
Previously not a single mention of "namespaces" and how to specify one.
### Motivation & context
Make docs easier.
I'm learning Apache Pulsar and had a confusion by the fact word "namespace" not mentioned even once in the nodejs part of the documentation. So it was impossible to know how to specify a namespace and/or tenant during topic manipulation (subscribing or connecting with a producer).
### Modifications
To address this problem, I added the topic name format (based on Pulsar console output) and examples to the documentation.
### Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (**no**)
- The public API: (**no**)
- The schema: (**no**)
- The default values of configurations: (**no**)
- The wire protocol: (**no**)
- The rest endpoints: (**no**)
- The admin cli options: (**no**)
- Anything that affects deployment: (**no**)
### Documentation
This is modification to the documentation itself (and only).
--
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 #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#discussion_r727663303
##########
File path: site2/docs/client-libraries-node.md
##########
@@ -137,7 +137,7 @@ Pulsar Node.js producers have the following methods available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. The topic format is `<topic-name>` or `<property(tenant)>/<namespace>/<topic-name>`. For example, `sample/ns1/my-topic` | |
Review comment:
```suggestion
| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. The topic format is `<topic-name>` or `<tenant-name>/<namespace-name>/<topic-name>`. For example, `sample/ns1/my-topic` | |
```
--
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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-891510860
@tuteng could you please help review this PR 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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-941873733
@sijia-w I've confirmed w/ eng, could you please help open another PR and update all versioned docs (from 2.2.0 to master) based on our comments? 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 edited a comment on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet edited a comment on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-941873733
@sijia-w I've confirmed w/ eng, now could you please help open another PR and update all versioned docs (from 2.2.0 to master) based on our comments? 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] sijia-w commented on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
sijia-w commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-941527075
@Anonymitaet Shall I create a new pr after @vsly-ru replies to this message? Thank you.
--
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 edited a comment on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet edited a comment on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-941873733
@sijia-w I've confirmed w/ eng, now could you please help open another PR and update all versioned docs (from 2.2.0 to master) based on our comments? 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 #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#discussion_r727663303
##########
File path: site2/docs/client-libraries-node.md
##########
@@ -137,7 +137,7 @@ Pulsar Node.js producers have the following methods available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. The topic format is `<topic-name>` or `<property(tenant)>/<namespace>/<topic-name>`. For example, `sample/ns1/my-topic` | |
Review comment:
```suggestion
| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. The topic format is `<topic-name>` or `<tenant-name>/<namespace-name>/<topic-name>`. For example, `sample/ns1/my-topic` | |
```
--
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] vsly-ru commented on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
vsly-ru commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-932723464
> Hi @vsly-ru can you take a look at our comments and make changes? Thanks
Sorry, I have encountered a lot of unexpected problems with Pulsar, e.g. `[pulsar-error] [192.168.1.3:52152 -> pulsar_ip:6650] Read failed: End of file` after the app relaunch randomly (and this error isn't even mentioned anywhere), calling `PulsarClient.close()` crashes the app with no reason and I couldn't even close the connection properly.
So I'm busy with gradually replacing Pulsar in some critical areas of the app I'm working on.
Sorry, I don't feel like participating with such a huge problems and time lost caused by Pulsar.
--
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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-903372598
Hi @vsly-ru any progress for the code and doc? 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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-941873733
@sijia-w I've confirmed w/ eng, could you please help open another PR and update all versioned docs (from 2.2.0 to master) based on our comments? 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] Jennifer88huang commented on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Jennifer88huang commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-895008472
> > @vsly-ru any progress of this PR? Thanks
>
> Sorry, I'm not familiar how to apply this PR to a multiple branches, can you give me a hint? Thanks.
@vsly-ru If your update applies to other versions, you can update them accordingly in [different versions here](https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs).
Here is an example: https://github.com/apache/pulsar/pull/10317/files
--
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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-927279380
Hi @vsly-ru can you take a look at our comments and make changes? 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] sijia-w commented on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
sijia-w commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-941527075
@Anonymitaet Shall I create a new pr after @vsly-ru replies to this message? Thank you.
--
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] sijie commented on a change in pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
sijie commented on a change in pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#discussion_r688826337
##########
File path: site2/docs/client-libraries-node.md
##########
@@ -107,7 +107,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify topic's property and namespace
Review comment:
```suggestion
topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify topic's tenant and namespace
```
--
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 closed pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet closed pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526
--
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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-939883527
Hi @vsly-ru, @sijia-w is willing to handle this doc change. Except `master`, are there any other doc versions that need to be updated? 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] vsly-ru commented on pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
vsly-ru commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-894668909
> @vsly-ru any progress of this PR? Thanks
Sorry, I'm not familiar how to apply this PR to a multiple branches, can you give me a hint? 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 pull request #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#issuecomment-894573082
@vsly-ru any progress of this PR? 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 #11526: [docs] Format and examples to specify a tenant/namespace for a topic.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #11526:
URL: https://github.com/apache/pulsar/pull/11526#discussion_r681421842
##########
File path: site2/docs/client-libraries-node.md
##########
@@ -137,7 +137,7 @@ Pulsar Node.js producers have the following methods available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. Format: `<topic-name>` or `<property(tenant)>/<namespace>/<topic-name>`. E.g.: `sample/ns1/my-topic` | |
Review comment:
```suggestion
| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the producer publishes messages. The topic format is `<topic-name>` or `<property(tenant)>/<namespace>/<topic-name>`. For example, `sample/ns1/my-topic` | |
```
--
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