[doc] Improve Pulsar Security-token-client#5039
Merged
sijie merged 5 commits intoapache:masterfrom Aug 28, 2019
Merged
Conversation
Jennifer88huang-zz
added
doc
| [JSON Web Tokens](https://jwt.io/introduction/) ([RFC-7519](https://tools.ietf.org/html/rfc7519)). | ||
|
|
||
| Tokens are used to identify a Pulsar client and associate with some "principal" (or "role") which | ||
| You can use tokens to identify a Pulsar client and associate with some "principal" (or "role") that |
Contributor
There was a problem hiding this comment.
Avoid to use "will be".
Try present tense. Check all similar cases.
site2/docs/security-token-client.md
Outdated
| ``` | ||
|
|
||
| Application will specify the token when the application is creating the client instance. An alternative is to pass a "token supplier" (a function that returns the token when the client library needs one). | ||
| Application specifies the token when the application is creating the client instance. An alternative is to pass a "token supplier" (a function that returns the token when the client library needs one). |
Contributor
There was a problem hiding this comment.
Could app create client instance?
site2/docs/security-token-client.md
Outdated
| Tokens are used to identify a Pulsar client and associate with some "principal" (or "role") which | ||
| will be then granted permissions to do some actions (eg: publish or consume from a topic). | ||
| You can use tokens to identify a Pulsar client and associate with some "principal" (or "role") that | ||
| is permitted to do some actions (eg: publish or consume from a topic) then. |
Contributor
There was a problem hiding this comment.
- do not use abbreviation in technical writing, not use "eg, etc. ...", you can use "for example", "such as".
- complete information: publish messages to a topic, consume messages from a topic.
- delete "then" at the end.
Jennifer88huang-zz
approved these changes
Aug 27, 2019
Member
|
run integration tests |
sijie
approved these changes
Aug 28, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Improve the language and the overall descriptive style of the Pulsar Security document (security-token-client section): http://pulsar.apache.org/docs/en/next/security-token-client/
Modifications
Adjust the tone, personal pronouns, voice also some typo errors of some sentences in the document.