yzeng25 commented on a change in pull request #4660:
URL: https://github.com/apache/apisix/pull/4660#discussion_r677176036



##########
File path: docs/en/latest/getting-started.md
##########
@@ -172,9 +170,7 @@ curl "http://127.0.0.1:9080/apisix/admin/upstreams/1"; -H 
"X-API-KEY: edd1c9f0343
 
 We use `roundrobin` as the load balancing mechanism, and set `httpbin.org:80` 
as our upstream target (Upstream service) with an ID of `1`. For more 
information on the fields, see [Admin API](./admin-api.md).
 
-:::note Note

Review comment:
       IMO we should keep it as it is right now. 
   
   Usually, contents behind or under `Note:` are something important or needed 
to be emphasized.
   
   The origin `Note:` is somewhat ambiguous (it could be note, tips, warnings 
or even fatal warnings, depends on how you modify or define them). Besides, 
plain text 'Note' is easy to be ignored or skipped. The purpose of using 
`:::note` and `:::` to quote a note is to make it more noticeable on docs 
website. 
   
   Yes, this is not convenient for GitHub readers. But why don't you checkout 
APISIX document website? This alternative is better.




-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to