[GitHub] [pulsar] Jennifer88huang commented on a change in pull request #11146: [Doc] Add descriptions for various API docs

[GitBox <gi...@apache.org>]

Jennifer88huang commented on a change in pull request #11146:
URL: https://github.com/apache/pulsar/pull/11146#discussion_r660999687



##########
File path: site2/docs/admin-api-brokers.md
##########
@@ -4,16 +4,26 @@ title: Managing Brokers
 sidebar_label: Brokers
 ---
 
+> **Important**

Review comment:
       Do we need to add the same note everywhere in the docs? If it's general note that users need to pay attention to, it's better to highlight it in a central place, e.g.: overview.
   
   We do not need to replace the same content again and again in all docs.

##########
File path: site2/docs/admin-api-brokers.md
##########
@@ -4,16 +4,26 @@ title: Managing Brokers
 sidebar_label: Brokers
 ---
 
+> **Important**
+>
+> This page only shows **some frequently used operations**.
+>
+> - For the latest and complete information about `pulsar-admin`, including commands, flags, descriptions, and more, see [here](https://pulsar.apache.org/tools/pulsar-admin/).
+> 
+> - For the latest and complete information about `REST API`, including parameters, responses, samples, and more, see [here]{@inject: rest:REST:/}.
+> 
+> - For the latest and complete information about `Java admin API`, including classes, methods, descriptions, and more, see [here](https://pulsar.apache.org/api/admin/).
+
 Pulsar brokers consist of two components:
 
 1. An HTTP server exposing a {@inject: rest:REST:/} interface administration and [topic](reference-terminology.md#topic) lookup.
 2. A dispatcher that handles all Pulsar [message](reference-terminology.md#message) transfers.
 
 [Brokers](reference-terminology.md#broker) can be managed via:
 
-* The [`brokers`](reference-pulsar-admin.md#brokers) command of the [`pulsar-admin`](reference-pulsar-admin.md) tool
+* The `brokers` command of the [`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/) tool

Review comment:
       Thank you for fixing the links one by one.  
   In the future, we can add link for the first time it appears, and do not add links for other occurances.




-- 
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