update readme file with default attributes

[holms]

Sorry for bugging but I'm completely confused with your README.
Good example would be this cookbook: https://github.com/lusis/chef-logstash

Most setups goes with chef-server, instead of chef-solo. You proposed a node.json instead of role.json. That's fine it's not hard to use this in role also, but what I'm confused about is that I don't see any default attributes in readme. For example what this one does?

 "bootstrap.mlockall" : false

I could update readme my self, although I'm not sure if you'd be happy with that format as lusis/chef-logstash cookbook goes. I've noticed that plenty of cookbooks follows same pattern, for example the one from Opscode itself: https://github.com/opscode-cookbooks/openvpn

[karmi]

I'm sorry but I don't understand your point here. The Readme has a section on Chef Server deployments: https://github.com/elasticsearch/cookbook-elasticsearch#chef-server

"bootstrap.mlockall" : false is simply an Elasticsearch configuration value -- see the documentation.

To inspect the default attributes, just consult the attributes/default.rb file -- I don't see any reason to list and describe them in the Readme, since most of them map transparently to Elasticsearch configuration, and you need to consult the Elasticsearch documentation to understand them.

[holms]

as far I've used any cookbook of chef which is on github, in readme there's usually full description of attributes/default.rb. see these:

https://github.com/opscode-cookbooks/openvpn
https://github.com/lusis/chef-logstash
https://github.com/alappe/cookbook-beaver

Thanks for pointing to elasticsearch docs

[karmi]

Hi, I'm sorry but I still maintain that simply listing all the attributes from default.rb (and other) files in the README doesn't bring much benefit to the end user, and would spoil the narrative of the README, which is focused on explaining usage of the cookbook.

I'm quite familiar with most cookbooks listing all (or almost all) attributes in the README, and don't want to go that route in this cookbook.

If you'd like to discuss the issue further, let's continue here or ping me at IRC!