airbnb/synapse
A transparent service discovery framework for connecting an SOA – Read the documentation
This page shows an evaluation of the documentation of airbnb/synapse.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
| Seems really good | ||
|---|---|---|
|
A
|
Synapse |
|
|
A
|
Synapse::ZookeeperDnsWatcher::Zookeeper#reconfigure! |
|
|
A
|
Synapse::ZookeeperDnsWatcher::Messages::NewServers |
|
|
A
|
Synapse::ZookeeperDnsWatcher::Dns#discovery_servers= |
|
|
A
|
Synapse::Haproxy#generate_shared_frontend |
|
| Show 15 more ... | ||
|
A
|
Synapse::Haproxy#generate_base_config |
|
|
A
|
Synapse::BaseWatcher#start |
|
|
A
|
Synapse::BaseWatcher#stop |
|
|
A
|
Synapse::Haproxy#restart |
|
|
A
|
Synapse::Synapse#run |
|
|
A
|
Synapse::ZookeeperDnsWatcher::Messages |
|
|
A
|
Synapse::ZookeeperDnsWatcher::Dns#discovery_servers |
|
|
A
|
Synapse::ZookeeperDnsWatcher::Dns#stop |
|
|
A
|
Synapse::ZookeeperDnsWatcher#start |
|
|
A
|
Synapse::ZookeeperDnsWatcher#stop |
|
|
A
|
Synapse::ZookeeperWatcher#start |
|
|
A
|
Synapse::ZookeeperWatcher#stop |
|
|
A
|
Synapse::DockerWatcher#start |
|
|
A
|
Synapse::EC2Watcher#start |
|
|
A
|
Synapse::DnsWatcher#start |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Synapse::Haproxy#generate_frontend_stanza |
|
|
B
|
Synapse::Haproxy#parse_watcher_config |
|
|
B
|
Synapse::Haproxy#update_backends |
|
|
B
|
Synapse::Haproxy#generate_config |
|
|
B
|
Synapse::Haproxy#construct_name |
|
| Show 2 more ... | ||
|
B
|
Synapse::ServiceWatcher.create |
|
|
B
|
Synapse::Haproxy#write_config |
|
| Needs work | ||
|---|---|---|
| – |
| Undocumented | ||
|---|---|---|
|
U
|
Synapse::Synapse#reconfigure! |
|
|
U
|
Synapse:: … ::NewServers#servers= |
|
|
U
|
Synapse:: … ::NewServers#servers |
|
|
U
|
Synapse::Haproxy#validate_haproxy_stanza |
|
|
U
|
Synapse::Haproxy#generate_backend_stanza |
|
| Show 30 more ... | ||
|
U
|
Synapse::ZookeeperDnsWatcher::Zookeeper |
|
|
U
|
Synapse::DnsWatcher#discovery_servers |
|
|
U
|
Synapse::Logging.configure_logger_for |
|
|
U
|
Synapse::ZookeeperDnsWatcher::Dns |
|
|
U
|
Synapse::BaseWatcher#initialize |
|
|
U
|
Synapse::Haproxy#update_config |
|
|
U
|
Synapse::BaseWatcher#backends |
|
|
U
|
Synapse::ZookeeperDnsWatcher |
|
|
U
|
Synapse::BaseWatcher#haproxy |
|
|
U
|
Synapse::Synapse#initialize |
|
|
U
|
Synapse::Logging.logger_for |
|
|
U
|
Synapse::Haproxy#initialize |
|
|
U
|
Synapse::ZookeeperWatcher |
|
|
U
|
Synapse::BaseWatcher#name |
|
|
U
|
Synapse::ServiceWatcher |
|
|
U
|
Synapse::DockerWatcher |
|
|
U
|
Synapse::Haproxy#opts |
|
|
U
|
Synapse::BaseWatcher |
|
|
U
|
Synapse::Logging#log |
|
|
U
|
Synapse::EC2Watcher |
|
|
U
|
Synapse::DnsWatcher |
|
|
U
|
Synapse::Haproxy |
|
|
U
|
Synapse::Synapse |
|
|
U
|
Synapse::Logging |
|
|
U
|
Synapse#log |
|
|
U
|
Synapse::ZookeeperDnsWatcher::Zookeeper#initialize |
|
|
U
|
Synapse::ZookeeperDnsWatcher::Dns#initialize |
|
|
U
|
Synapse::ZookeeperDnsWatcher::Dns#watch |
|
|
U
|
Synapse::ZookeeperDnsWatcher#backends |
|
|
U
|
Synapse::Haproxy::@@section_fields |
|
Let's raise the visibility of documentation in Ruby!
This page is for airbnb/synapse and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
What is the goal of this?
I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk.
Suggestions, feedback, critique: Hit me up on Twitter or via issue.
nch Pages