diff --git a/README-zh.md b/README-zh.md index ff6804135..e42a01e04 100644 --- a/README-zh.md +++ b/README-zh.md @@ -34,7 +34,7 @@ Spring Cloud 使用 Maven 来构建，最快的使用方式是将本项目clone Example 列表： -[sentinel example](https://github.com/spring-cloud-incubator/spring-cloud-alibabacloud/spring-cloud-alibaba-examples/sentinel-example/readme-zh.md) +[sentinel example](https://github.com/spring-cloud-incubator/spring-cloud-alibabacloud/blob/master/spring-cloud-alibaba-examples/sentinel-example/readme-zh.md) ## 版本管理规范 diff --git a/README.md b/README.md index 86bc57366..e845f9e12 100644 --- a/README.md +++ b/README.md @@ -35,19 +35,19 @@ A `spring-cloud-alibaba-examples` module is included in our project for you to g Examples： -[Sentinel example](https://github.com/spring-cloud-incubator/spring-cloud-alibabacloud/spring-cloud-alibaba-examples/sentinel-example/readme.md) +[Sentinel example](https://github.com/spring-cloud-incubator/spring-cloud-alibabacloud/blob/master/spring-cloud-alibaba-examples/sentinel-example/readme.md) ## Version control guidelines The version number of the project is in the form of x.x.x, where x is a number, starting from 0, and is not limited to the range 0~9. When the project is in the incubator phase, the first version number is fixed to 0, that is, the version number is 0.x.x. -As the interfaces and annotations of Spring Boot 1 and Spring Boot 2 have been changed significantly in the Acutator module, and spring-cloud-commons is also changed quite a lot from 1.x.x to 2.0.0, we maintain two different branches to support Spring Boot 1 and Spring Boot 2: +As the interfaces and annotations of Spring Boot 1 and Spring Boot 2 have been changed significantly in the Actuator module, and spring-cloud-commons is also changed quite a lot from 1.x.x to 2.0.0, we maintain two different branches to support Spring Boot 1 and Spring Boot 2: * 0.1.x for Spring Boot 1 * 0.2.x for Spring Boot 2 During the incubation period，the version management of the project will follow these rules： * Functional updates will be reflected in the 3rd number of the version, for example, the next version of 0.1.0 will be 0.1.1。 -* Emergency fixes for bugs that block the main business process will be refelected in version numbers such as 0.1.1.fix. However, it is our duty to improve the test regression process to avoid such scnearions. +* Emergency fixes for bugs that block the main business process will be reflected in version numbers such as 0.1.1.fix. However, it is our duty to improve the test regression process to avoid such scenarios. diff --git a/spring-cloud-alibaba-examples/sentinel-example/readme-zh.md b/spring-cloud-alibaba-examples/sentinel-example/readme-zh.md index d832c86b1..271f2efc0 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/readme-zh.md +++ b/spring-cloud-alibaba-examples/sentinel-example/readme-zh.md @@ -23,7 +23,7 @@ 1. 接入限流埋点 1. HTTP埋点 - Sentienl starter 默认为所有的 HTTP 服务提供了限流埋点，如果只想对 HTTP 服务进行限流，那么只需要引入依赖，无需修改代码。 + Sentinel starter 默认为所有的 HTTP 服务提供了限流埋点，如果只想对 HTTP 服务进行限流，那么只需要引入依赖，无需修改代码。 1. 自定义埋点 如果需要对某个特定的方法进行限流或降级，可以通过 @EnableSentinel 来完成限流的埋点，示例代码如下 diff --git a/spring-cloud-alibaba-examples/sentinel-example/readme.md b/spring-cloud-alibaba-examples/sentinel-example/readme.md index 6864063d0..6edcada68 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/readme.md +++ b/spring-cloud-alibaba-examples/sentinel-example/readme.md @@ -22,7 +22,7 @@ Before we start the demo, let's learn how to connect Sentinel to a Spring Cloud 2. Define Resources 1. Define HTTP Resources - Sentienl starter defines all HTTP URLS as resources by relative paths. If you only want to add flow control for your HTTP services, you do not need to modify your code. + Sentinel starter defines all HTTP URLS as resources by relative paths. If you only want to add flow control for your HTTP services, you do not need to modify your code. 1. Define Custom Resources If you want to implement flow control or degradation for a specific method, you can add an @EnableSentinel annotation to the method, as shown in the code below. @@ -54,7 +54,7 @@ Before we start the demo, let's learn how to connect Sentinel to a Spring Cloud 1. Install Sentinel dashboard by downloading a fatjar or build from source code. - 1. Download: [Downlaod Sentinel Dashboard](http://edas-public.oss-cn-hangzhou.aliyuncs.com/install_package/demo/sentinel-dashboard.jar) + 1. Download: [Download Sentinel Dashboard](http://edas-public.oss-cn-hangzhou.aliyuncs.com/install_package/demo/sentinel-dashboard.jar) 2. Build from source code: Get source code by `git clone git@github.com:alibaba/Sentinel.git` from [Github Sentinel](https://github.com/alibaba/Sentinel) and build your code. See [build reference](https://github.com/alibaba/Sentinel/tree/master/sentinel-dashboard) for details. 2. Start the dashboard by running the `java -jar sentinel-dashboard.jar` command. @@ -73,7 +73,7 @@ Before we start the demo, let's learn how to connect Sentinel to a Spring Cloud 1. Start in IDE: Find main class `ServiceApplication`, and execute the main method. 2. Build a fatjar：Execute command `mvn clean package` to build a fatjar，and run command `java -jar sentinel-example.jar` to start the application. -### Invoke Serivce +### Invoke Service Execute command `curl http://127.0.0.1:18083/hello` Execute command `curl http://127.0.0.1:18083/test` @@ -145,18 +145,18 @@ The screenshot belows shows invoke success: ## Endpoint -Sentinel starter also supports the implmentation of Spring Boot acutator endpoints. +Sentinel starter also supports the implementation of Spring Boot actuator endpoints. **Prerequisite:** -Add denpendency `spring-boot-starter-actuator` to your pom.xml file, and configure your endpoint security stategy. +Add dependency `spring-boot-starter-actuator` to your pom.xml file, and configure your endpoint security strategy. * Spring Boot1.x: Add configuration `management.security.enabled=false` * Spring Boot2.x: Add configuration `management.endpoints.web.exposure.include=*` To view the endpoint information, visit the following URLS: * Spring Boot1.x: Sentinel Endpoint URL is http://127.0.0.1:18083/sentinel. -* Spring Boot2.x: Sentinel Endpoint URL is http://127.0.0.1:18083/acutator/sentinel. +* Spring Boot2.x: Sentinel Endpoint URL is http://127.0.0.1:18083/actuator/sentinel.