[website]Add content of pulsar-manager in website(include release notes, download link)#5741
Conversation
|
@Anonymitaet Could you please help review this PR? Thank you. |
|
@jennifer88huang glad to help |
There was a problem hiding this comment.
| The easiest way to use the pulsar manager is to run it inside a [Docker](https://www.docker.com/products/docker) container. | |
| The easiest way to use the Pulsar Manager is to run it inside a [Docker](https://www.docker.com/products/docker) container. |
Pulsar Manager is a proper noun, please use the correct capitalization and check all occurrences.
There was a problem hiding this comment.
| * URL: the url of PostgreSQL jdbc, example: jdbc:postgresql://127.0.0.1:5432/pulsar_manager. | |
| * URL: the URL of PostgreSQL JDBC. For example, `jdbc:postgresql://127.0.0.1:5432/pulsar_manager`. |
Please capitalize proper nouns correctly.
There was a problem hiding this comment.
Find what in the Docker?
Please capitalize "Docker" correctly. I suggest using a grammar tool before submitting a PR.
There was a problem hiding this comment.
| 1. Initialize database and table structures using [file](https://github.com/apache/pulsar-manager/tree/master/src/main/resources/META-INF/sql/postgresql-schema.sql). | |
| 1. Initialize database and table structures using the [file](https://github.com/apache/pulsar-manager/tree/master/src/main/resources/META-INF/sql/postgresql-schema.sql). |
Please use a grammar tool to check basic grammar mistakes before submitting a PR.
There was a problem hiding this comment.
| 2. Modify the [configuration file](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/application.properties) and add PostgreSQL configuration | |
| 2. Modify the [configuration file](https://github.com/apache/pulsar-manager/blob/master/src/main/resources/application.properties) and add PostgreSQL configuration. |
There was a problem hiding this comment.
| 3. Compile to generate a new executable jar package | |
| 3. Compile to generate a new executable jar package. |
There was a problem hiding this comment.
| ### Enable JWT Auth | |
| ### Enable JWT authentication |
We use sentence case rather than title case for heading.
There was a problem hiding this comment.
| * backend.jwt.token token for the superuser. You need to configure this parameter during cluster initialization. | |
| * `backend.jwt.token`: token for the superuser. You need to configure this parameter during cluster initialization. |
Please check all (line 72-75).
There was a problem hiding this comment.
| For more information, see [Apache Pulsar](http://pulsar.apache.org/docs/en/security-token-admin/) | |
| For more information, see [Token Authentication Admin of Pulsar](http://pulsar.apache.org/docs/en/security-token-admin/). |
Tell users more and accurate info.
There was a problem hiding this comment.
| * Method 2. Configure the application.properties file | |
| * Method 2: Configure the application.properties file |
There was a problem hiding this comment.
What does "use Docker only use token" mean?
There was a problem hiding this comment.
Do you mean "Use Docker with token and secret key"?
There was a problem hiding this comment.
| ## Login platform | |
| ## Log in |
Use parallel structure with "Install"
|
@Anonymitaet PTAL |
There was a problem hiding this comment.
| title: The Pulsar Manager | |
| title: Pulsar Manager |
There was a problem hiding this comment.
Do you need to delete the word The? http://pulsar.apache.org/docs/en/administration-dashboard/
There was a problem hiding this comment.
Yes. Do not add an article before a proper noun.
For example, we say "In 2013 Oracle introduced Oracle Database 12c—the world's first database designed for the cloud. " rather than "In 2013 Oracle introduced the Oracle Database 12c—the world...".
There was a problem hiding this comment.
I've commented before but it is not changed
There was a problem hiding this comment.
| * `jwt.broker.token.mode`: Two modes of generating token, SECRET and PRIVATE. | |
| * `jwt.broker.token.mode`: two modes of generating token, SECRET and PRIVATE. |
I've commented on this before as well. Please check lines 72-75.
There was a problem hiding this comment.
| For more information, see [Token Authentication Admin of Pulsar](http://pulsar.apache.org/docs/en/security-token-admin/) | |
| For more information, see [Token Authentication Admin of Pulsar](http://pulsar.apache.org/docs/en/security-token-admin/). |
There was a problem hiding this comment.
| If you want to enable JWT authentication, use one of the following methods. |
Is this correct?
There was a problem hiding this comment.
| * Method 4: Use Docker, turn on token authentication and turn on token management by private key and public key. | |
| * Method 4: Use Docker and turn on **token authentication** and **token management** by private key and public key. |
There was a problem hiding this comment.
| * Method 5: Use Docker, turn on token authentication and turn on token management by secret key. | |
| * Method 5: use Docker and turn on **token authentication** and **token management** by secret key. |
There was a problem hiding this comment.
I commented on this before as well.
There was a problem hiding this comment.
| ## Log in platform | |
| ## Log in |
There was a problem hiding this comment.
| Visit http://localhost:9527 | |
| Visit http://localhost:9527 to log in. |
|
You can preview the doc before submitting a PR.
|
|
Thank you for your comments. |
|
@Anonymitaet can you review it again? |
There was a problem hiding this comment.
Yes. Do not add an article before a proper noun.
For example, we say "In 2013 Oracle introduced Oracle Database 12c—the world's first database designed for the cloud. " rather than "In 2013 Oracle introduced the Oracle Database 12c—the world...".
|
@Anonymitaet PTAL, Thanks. |
There was a problem hiding this comment.
| * For more information about backend configurations, see [here](https://github.com/apache/pulsar-manager/blob/8b1f26f7d7c725e6d056c41b98235fbc5deb9f49/src/README.md) about backend. | |
| * For more information about backend configurations, see [here](https://github.com/apache/pulsar-manager/blob/8b1f26f7d7c725e6d056c41b98235fbc5deb9f49/src/README.md). |
There was a problem hiding this comment.
| * For more information about frontend configurations, see [here](https://github.com/apache/pulsar-manager/blob/master/front-end/README.md) about frontend. | |
| * For more information about frontend configurations, see [here](https://github.com/apache/pulsar-manager/blob/master/front-end/README.md). |
There was a problem hiding this comment.
Sorry, I didn't notice here. I have already fixed it. @Anonymitaet PTAL
|
@Anonymitaet PTAL |
|
run java8 tests |
|
run java8 tests |
1 similar comment
|
run java8 tests |
tuteng
force-pushed
the
feature/add-release-notes-download-and-doc
branch
from
1f0e5d3 to
e232a79
Compare
|
run integration tests |
|
run java8 tests |
1 similar comment
|
run java8 tests |
5 participants
Motivation
As a sub-project of the pulsar, pulsar-manager should update relevant content on the website after the first release is completed, so as to facilitate users' use.
Modifications
Verifying this change
yarn build pass