[docs] Format and examples to specify a tenant/namespace for a topic. #11526
Conversation
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.
Jennifer88huang-zz
added
the
doc
There was a problem hiding this comment.
@vsly-ru many Thanks for your contribution. Does this affect only master or other versioned docs?
If latter, could you please help update all affected versions? Thanks
|
@tuteng could you please help review this PR from the technical perspective? Thanks |
|
@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. |
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@vsly-ru If your update applies to other versions, you can update them accordingly in different versions here. |
| @@ -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 | |||
There was a problem hiding this comment.
| topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify topic's property and namespace | |
| topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify topic's tenant and namespace |
|
Hi @vsly-ru any progress for the code and doc? Thanks. |
|
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. |
|
@Anonymitaet Shall I create a new pr after @vsly-ru replies to this message? Thank you. |
|
@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 |
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:
Documentation
This is modification to the documentation itself (and only).