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

Improve plugin documentation #11

Merged
merged 2 commits into from
Oct 11, 2016
Merged

Improve plugin documentation #11

merged 2 commits into from
Oct 11, 2016

Conversation

corro
Copy link
Contributor

@corro corro commented Oct 10, 2016

An attempt to improve the plugin documentation as a reaction to https://groups.google.com/d/topic/sensu-users/iq_7kdah6Rc/discussion.

I tried to follow https://github.com/GhostLyrics/sensu-plugin-doc-draft where possible, but I found the section Files to be redundant, so I removed it completely.

@cwjohnston
Copy link
Contributor

Hi @corro, thanks for this awesome pull request; a huge improvement over the existing documentation!

Will you please update the install example to include the --plugin or -p flag? e.g.

sensu-install --plugin sensu-plugins-ntp

It's missing from the source template, and I've opened a pull request to fix it there.

@corro
Copy link
Contributor Author

corro commented Oct 11, 2016

@cwjohnston, thanks for the hint, it's fixed now. I followed blindly the example in the draft, good to see it has been corrected there as well.

@sstarcher sstarcher merged commit 484eee7 into sensu-plugins:master Oct 11, 2016
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

Successfully merging this pull request may close these issues.

3 participants