Hystrix icon indicating copy to clipboard operation
Hystrix copied to clipboard

Documentation Contribution

Open bootups opened this issue 7 years ago • 9 comments

I have documented some of your code examples on the: https://github.com/Netflix/Hystrix/wiki/How-To-Use, page.

The documentation describes the internal architecture of Hystrix, using Sequence Diagrams and Class Diagrams. The documentation is visual and easy to consume. I have done up the following dashboards:

  • How it Works/Request Caching: https://design.codelytics.io/hystrix/how-it-works
  • Request Collapsing: https://design.codelytics.io/hystrix/request-collapsing
  • Fallback Timeout: https://design.codelytics.io/hystrix/fallback

The documentation would be useful for Users and Hystrix Developers alike, as it gives an internal understanding of how Hystrix works. If you feel this type of documentation would be useful for your Users/Developers, let me know and I can extend it to cover other aspects of Hystrix.

bootups avatar May 23 '17 11:05 bootups

@adrianb11 I can't reach any of those links. Are they intended to be public?

mattrjacobs avatar Jun 02 '17 17:06 mattrjacobs

@mattrjacobs, sorry the links have been fixed

bootups avatar Jun 02 '17 22:06 bootups

Thanks @adrianb11. Yeah, this does look helpful - thanks for the links

mattrjacobs avatar Jun 14 '17 21:06 mattrjacobs

@mattrjacobs thanks for the feedback, if you think the links would help developers and users understand Hystrix, maybe include the links somewhere on your wiki?

bootups avatar Jun 15 '17 10:06 bootups

I've added https://github.com/Netflix/Hystrix/wiki/How-it-Works#SequenceDiagram and augmented https://github.com/Netflix/Hystrix/wiki/How-To-Use#Fallback and https://github.com/Netflix/Hystrix/wiki/How-it-Works#RequestCollapsing.

Thanks again!

mattrjacobs avatar Jul 03 '17 22:07 mattrjacobs

@bootups the https://design.codelytics.io/hystrix/how-it-works is so helpful for me, how it works on design.codelytics.io. I want to use it for more Java open source products.

ae6623 avatar Feb 23 '18 11:02 ae6623

@bootups Hi bro, I'm checking out Hystrix's Wiki and I found these links are all unavailable now.

504 ERROR
The request could not be satisfied.

Since it's in official wiki I think it's quite useful for developers like me to understand how it works. I know it's been 4 years since you posted these links, but is there any possibility to fix this?

KyleRicardo avatar Jul 07 '21 06:07 KyleRicardo

I've added https://github.com/Netflix/Hystrix/wiki/How-it-Works#SequenceDiagram and augmented https://github.com/Netflix/Hystrix/wiki/How-To-Use#Fallback and https://github.com/Netflix/Hystrix/wiki/How-it-Works#RequestCollapsing.

Thanks again!

Is it possible to update the link ?

ryukans avatar Aug 23 '22 09:08 ryukans

好的,我已收到。

ThinkingMan007 avatar Aug 23 '22 09:08 ThinkingMan007