{"action":"created","issue":{"url":"https://api.github.com/repos/firehol/netdata/issues/643","repository_url":"https://api.github.com/repos/firehol/netdata","labels_url":"https://api.github.com/repos/firehol/netdata/issues/643/labels{/name}","comments_url":"https://api.github.com/repos/firehol/netdata/issues/643/comments","events_url":"https://api.github.com/repos/firehol/netdata/issues/643/events","html_url":"https://github.com/firehol/netdata/pull/643","id":163678493,"number":643,"title":"python.d squid + hddtemp + minor fixes","user":{"login":"paulfantom","id":3531758,"avatar_url":"https://avatars.githubusercontent.com/u/3531758?v=3","gravatar_id":"","url":"https://api.github.com/users/paulfantom","html_url":"https://github.com/paulfantom","followers_url":"https://api.github.com/users/paulfantom/followers","following_url":"https://api.github.com/users/paulfantom/following{/other_user}","gists_url":"https://api.github.com/users/paulfantom/gists{/gist_id}","starred_url":"https://api.github.com/users/paulfantom/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulfantom/subscriptions","organizations_url":"https://api.github.com/users/paulfantom/orgs","repos_url":"https://api.github.com/users/paulfantom/repos","events_url":"https://api.github.com/users/paulfantom/events{/privacy}","received_events_url":"https://api.github.com/users/paulfantom/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":17,"created_at":"2016-07-04T13:36:18Z","updated_at":"2016-07-06T09:24:40Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/firehol/netdata/pulls/643","html_url":"https://github.com/firehol/netdata/pull/643","diff_url":"https://github.com/firehol/netdata/pull/643.diff","patch_url":"https://github.com/firehol/netdata/pull/643.patch"},"body":"First of all I changed name of misleading method `_format_data` to `_get_data` and introduced `_get_raw_data` where it was needed.\r\n\r\nCreated `squid.chart.py` and `hddtemp.chart.py`, both of which are using new `NetSocketService` class.\r\n\r\nEverything but `squid.chart.py` was tested. \r\nWith `squid.chart.py` I've done some basic tests like autodetection and requests on `/squid-internal-mgr/counters`, but none of it was done on `squid` server."},"comment":{"url":"https://api.github.com/repos/firehol/netdata/issues/comments/230722343","html_url":"https://github.com/firehol/netdata/pull/643#issuecomment-230722343","issue_url":"https://api.github.com/repos/firehol/netdata/issues/643","id":230722343,"user":{"login":"ktsaou","id":2662304,"avatar_url":"https://avatars.githubusercontent.com/u/2662304?v=3","gravatar_id":"","url":"https://api.github.com/users/ktsaou","html_url":"https://github.com/ktsaou","followers_url":"https://api.github.com/users/ktsaou/followers","following_url":"https://api.github.com/users/ktsaou/following{/other_user}","gists_url":"https://api.github.com/users/ktsaou/gists{/gist_id}","starred_url":"https://api.github.com/users/ktsaou/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ktsaou/subscriptions","organizations_url":"https://api.github.com/users/ktsaou/orgs","repos_url":"https://api.github.com/users/ktsaou/repos","events_url":"https://api.github.com/users/ktsaou/events{/privacy}","received_events_url":"https://api.github.com/users/ktsaou/received_events","type":"User","site_admin":false},"created_at":"2016-07-06T09:24:39Z","updated_at":"2016-07-06T09:24:39Z","body":"Keep in mind that the best place to have the configuration documentation about each module, is the configuration file itself. People will never need to search for docs. They will just open the configuration file and read the comments.\r\n\r\nOnce we commit this, I plan to add comments on each configuration file, include other example configurations.\r\n\r\nTo understand how effective this is, consider this example: apps.plugin has a heavily commented configuration file: https://github.com/firehol/netdata/blob/master/conf.d/apps_groups.conf\r\n\r\nThis configuration file has very limited documentation on the wiki: https://github.com/firehol/netdata/wiki/Apps-Plugin#configuration\r\n\r\nHowever, I linked the configuration file from the netdata dashboard:\r\n![image](https://cloud.githubusercontent.com/assets/2662304/16613363/5dde6366-4374-11e6-8402-1e5d1f244981.png)\r\n\r\nAnd this configuration has the most PRs ! Yes, people do find it, do configure it, and do submit PRs to extend it.\r\n\r\nSo, my understanding is that having configuration documentation at the config file is the best possible choice."}}
{"actor":{"display_login":"ktsaou"}}