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

1.0 should have sensible documentation #344

Closed
michaelklishin opened this issue Jul 16, 2015 · 4 comments
Closed

1.0 should have sensible documentation #344

michaelklishin opened this issue Jul 16, 2015 · 4 comments

Comments

@michaelklishin
Copy link
Contributor

I see you've released v1.0. Congratulations!

I've recently looked into using the master (now 1.0) version of this cookbook. My experience was less than stellar. In the 0.3.x series, it was easy to provision ES with the AWS plugin and minimum fuss.

In this version, there's barely any documentation. A blog post that was supposed to demonstrate things no longer exists (#293). Figuring out what plugin_dir should be is a pain.

I think releasing 1.0 with very little documentation was a mistake. Consider putting all the refactoring aside and spending some time on the docs. For now, there is no reason for me to use 1.0. I'll stick to 0.3.x which works and had enough examples to make it do what I want in less than 10 minutes.

@michaelklishin michaelklishin changed the title Sensible documentation 1.0 should have sensible documentation Jul 16, 2015
@martinb3
Copy link
Contributor

Hello!

I'm sorry you don't judge my contributions to be useful. I'd encourage you to submit specific, constructive criticism, and I'd would be glad to review and merge it.

In this version, there's barely any documentation.

Practically all I've done today is write documentation. I wish there was more, but I'd welcome contributions.

A blog post that was supposed to demonstrate things no longer exists

I don't own the elasticsearch.org site. I don't work for Elastic, and my contributions are in the spirit of open source. Though, I think it would probably be premature to write a blog post for a version that hasn't been released. I did personally post an announcement on the chef users list more than a week ago asking for feedback.

Figuring out what plugin_dir should be is a pain.

Since you've already opened a specific issue for this, I will address your question there in #345.

In the mean time, please feel free to keep using the older version until there is more documentation.

@martinb3
Copy link
Contributor

I'm not sure what else to do with this issue. Calling someone's work a mistake is not constructive.

@michaelklishin
Copy link
Contributor Author

@martinb3 sorry, I didn't mean to call your work worthless. I know first hand that maintaining a cookbook
(or any project) can be a time consuming and thankless job. I meant to say that slapping 1.0 on a largely undocumented project a mistake. The direction in which this cookbook is going has some strong opinions but fair enough: there are multiple ways to do the same thing in Chef.

I will file more specific issues and hopefully documentation improvements.

@martinb3
Copy link
Contributor

I appreciate your note @michaelklishin. I'm motivated to improve things where-ever we can. I hope we can get it to a point where you'll feel like it's worth upgrading.

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