Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

print_value docs don't mention elasticsearch #169

Closed
josephholsten opened this issue Dec 5, 2013 · 3 comments
Closed

print_value docs don't mention elasticsearch #169

josephholsten opened this issue Dec 5, 2013 · 3 comments

Comments

@josephholsten
Copy link

print_value.rb has docs like

    #    <%= print_value 'foo.bar' -%> is evaluated in multiple ways in this order:
    #
    #    a) as `node['foo.bar']`,
    #    b) as `node['foo_bar']`,
    #    c) as `node.foo.bar` (ie. `node[:foo][:bar]`)
    #

this doesn't mention that you're actually pulling from node['elasticsearch'].

Seems like a simple docfix, and probably deserves a decent mention in the read me.

@karmi karmi closed this as completed in 1ad0f5c Dec 5, 2013
@karmi
Copy link
Contributor

karmi commented Dec 5, 2013

Hi, I've updated the documentation to state this fact. I don't see a reason to put it into the README, since that is quite an internal implementation thing?

@josephholsten
Copy link
Author

I guess that's fine, but it's not immediately obvious that so much is configurable through node attributes.

Maybe I'm too quick to jump into the source, but knowing there's an easy way to access tunable without overriding the entire config seems worth mentioning explicitly in the readme.

Regardless, I'm glad I didn't have to do any patching to tune the zen discovery timeout. Thanks so much for the quick resolution!

http://josephholsten.com

On Dec 5, 2013, at 1:40, Karel Minarik notifications@github.com wrote:

Hi, I've updated the documentation to state this fact. I don't see a reason to put it into the README, since that is quite an internal implementation thing?


Reply to this email directly or view it on GitHub.

@karmi
Copy link
Contributor

karmi commented Dec 5, 2013

knowing there's an easy way to access tunable without overriding the entire config seems worth mentioning explicitly in the readme.

Aye, that is right -- there's a note in the default attributes file, but I think it would be indeed beneficial to have a more visible information in the Readme how to set all the optional attribute. I'll look into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants