You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/09/22 01:53:21 UTC

[GitHub] [apisix] tzssangglass commented on a change in pull request #5101: chore: clean up SkyWalking docs

tzssangglass commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713530885



##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -27,24 +27,25 @@ title: skywalking
 - [**Attributes**](#attributes)
 - [**How To Enable**](#how-to-enable)
 - [**Test Plugin**](#test-plugin)
-  - [**Run Skywalking Example**](#run-skywalking-example)
+  - [**Run SkyWalking Example**](#running-skywalking)

Review comment:
       text and links should keep same

##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -1,5 +1,5 @@
 ---
-title: skywalking
+title: SkyWalking

Review comment:
       No need for camel naming, keep it lowercase like the rest of the plugin documentation.

##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,20 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f1
 }'
 ```
 
-You also can complete the above operation through the web interface, first add a route, then add skywalking plugin:
+You also can complete the above operation through the web interface, first add a route, then add SkyWalking plugin:
 
 ![ ](../../../assets/images/plugin/skywalking-1.png)
 
-## How to set endpoint
+## How to Set Endpoint

Review comment:
       why change `set endpoint` to `Set Endpoint`? This title looks strange.

##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -206,7 +208,7 @@ plugins:
 
 And then reload APISIX.
 
-## Upstream services(Code With SpringBoot)
+## Upstream Services(Code With SpringBoot)

Review comment:
       ditto, this title looks strange.

##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -27,24 +27,25 @@ title: skywalking
 - [**Attributes**](#attributes)
 - [**How To Enable**](#how-to-enable)
 - [**Test Plugin**](#test-plugin)
-  - [**Run Skywalking Example**](#run-skywalking-example)
+  - [**Run SkyWalking Example**](#running-skywalking)

Review comment:
       ```suggestion
   - [**Running SkyWalking**](#running-skywalking)
   ```




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org