diff --git a/README.md b/README.md index 5f3ba4dd..8c559d45 100755 --- a/README.md +++ b/README.md @@ -33,7 +33,8 @@ See the [中文文档](https://github.com/alibaba/Sentinel/wiki/%E4%BB%8B%E7%BB% See the [Wiki](https://github.com/alibaba/Sentinel/wiki) for full documentation, examples, blog posts, operational details and other information. -**If you are using Sentinel, please [leave a comment here](https://github.com/alibaba/Sentinel/issues/18) to tell us your scenario to make Sentinel better :-)** +If you are using Sentinel, please [**leave a comment here**](https://github.com/alibaba/Sentinel/issues/18) to tell us your scenario to make Sentinel better. +It's also encouraged to add the link of your blog post, tutorial, demo or customized components to [**Awesome Sentinel**](./doc/awesome-sentinel.md). ## Quick Start @@ -139,6 +140,8 @@ Contact us: sentinel@linux.alibaba.com Contributions are always welcomed! Please see [CONTRIBUTING](./CONTRIBUTING.md) for detailed guidelines. +You can start with the issues labeled with [`good first issue`](https://github.com/alibaba/Sentinel/pulls?q=is%3Apr+is%3Aopen+label%3A%22good+first+issue%22). + ## Credits Thanks [Guava](https://github.com/google/guava), which provides some inspiration on rate limiting. diff --git a/doc/README.md b/doc/README.md index a460cc5f..1489e0d1 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1 +1,3 @@ -# Sentinel Documents \ No newline at end of file +# Sentinel related documents + +- [Awesome Sentinel](./awesome-sentinel.md) diff --git a/doc/awesome-sentinel.md b/doc/awesome-sentinel.md index ef7f319c..c6bcf490 100644 --- a/doc/awesome-sentinel.md +++ b/doc/awesome-sentinel.md @@ -5,7 +5,7 @@ A curated list of awesome things (e.g. sample, extensions, blogs) for [Sentinel](https://github.com/alibaba/Sentinel). If you want your component to appear here, send a pull request to this repository to add it. -You can refer to the [contribution guidelines](https://github.com/sentinel-group/sentinel-awesome/blob/master/CONTRIBUTING.md). +You can refer to the [awesome contribution guidelines](https://github.com/sentinel-group/sentinel-awesome/blob/master/CONTRIBUTING.md). You can also add to [sentinel-group/sentinel-awesome](https://github.com/sentinel-group/sentinel-awesome). @@ -31,14 +31,5 @@ You can also add to [sentinel-group/sentinel-awesome](https://github.com/sentine ## Blogs - [Sentinel 为 Dubbo 服务保驾护航](http://dubbo.apache.org/zh-cn/blog/sentinel-introduction-for-dubbo.html) by [Eric Zhao](https://github.com/sczyh30) -- [Sentinel 一体化监控解决方案 CrateDB + Grafana](https://blog.csdn.net/huyong1990/article/details/82392386) by [Young Hu](https://github.com/YoungHu) -- [在生产环境中使用 Sentinel 控制台](https://github.com/alibaba/Sentinel/wiki/%E5%9C%A8%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E4%B8%AD%E4%BD%BF%E7%94%A8-Sentinel-%E6%8E%A7%E5%88%B6%E5%8F%B0) by [Eric Zhao](https://github.com/sczyh30) -- [限流降级神器-哨兵(Sentinel)原理分析](https://mp.weixin.qq.com/s/7_pCkamNv0269e5l9_Wz7w) by [houyi](https://github.com/all4you) -- [限流降级神器-哨兵(Sentinel)的资源调用链原理分析](https://mp.weixin.qq.com/s/UEzwD22YC6jpp02foNSXnw) by [houyi](https://github.com/all4you) -- [限流降级神器-哨兵(Sentinel)基于滑动时间窗口的实时指标统计分析](https://mp.weixin.qq.com/s/B1_7Kb_CxeKEAv43kdCWOA) by [houyi](https://github.com/all4you) -- [Sentinel 控制台监控数据持久化【MySQL】(Spring Data JPA)](https://www.cnblogs.com/cdfive2018/p/9838577.html) by [cdfive](https://github.com/cdfive) -- [Sentinel 控制台监控数据持久化【InfluxDB】](https://www.cnblogs.com/cdfive2018/p/9914838.html) by [cdfive](https://github.com/cdfive) -- [Sentinel学习笔记(1)-- 流量统计代码解析](https://www.jianshu.com/p/7936d7a57924) by [ro9er](https://github.com/ro9er) -- [Sentinel学习笔记(2)-- 流量控制代码分析](https://www.jianshu.com/p/938709e94e43) by [ro9er](https://github.com/ro9er) -- [Sentinel学习笔记(3)-- 上下文统计Node建立分析](https://www.jianshu.com/p/cfdf525248c1) by [ro9er](https://github.com/ro9er) -- [大流量下的服务质量治理 Dubbo Sentinel初涉](https://mp.weixin.qq.com/s/ergr_siI07VwwSRPFgsLvQ) by [RyuGrade](https://github.com/RyuGrade) \ No newline at end of file +- [Sentinel 与 Hystrix 的对比](https://github.com/alibaba/Sentinel/wiki/Sentinel-%E4%B8%8E-Hystrix-%E7%9A%84%E5%AF%B9%E6%AF%94) +- [Guideline: 从 Hystrix 迁移到 Sentinel](https://github.com/alibaba/Sentinel/wiki/Guideline:-%E4%BB%8E-Hystrix-%E8%BF%81%E7%A7%BB%E5%88%B0-Sentinel) \ No newline at end of file