Fleshing out the skeleton README 💀 #8
Conversation
* Giving further context on how someone might use this file * Providing a - hopefully - inspirational checklist to follow
|
Does this warrant a CHANGELOG entry? Not sure. |
|
I missed the opportunity to write "💀->😛" for fleshing out 😆. Darn. |
| ## Files | ||
| * Copy the files in this repository if you want to write a Ruby plugin following best practices of layout and structure | ||
| * To write the actual functionality, you'll need to import [Sensu Plugin gem](https://github.com/sensu-plugins/sensu-plugin) | ||
| * If you'd prefer writing in Python, use the [Python Plugin library](https://github.com/sensu-plugins/sensu-plugin-python) |
There was a problem hiding this comment.
For the moment I still encourage copying and packaging it as a gem an addition to a pypi packages. The reason is that this now introduces 2 ways to install plugins. This is especially true since many plugins that have python, ruby, (bash|powershell) in the same project. While this is a larger discussion: sensu-plugins/community#70 I just wanted to point out and decide if we want to adjust any verbiage here.
There was a problem hiding this comment.
Ok I think I can mention that as another checkbox below 9: "Regardless of the programming language, complete the gem packaging so its easily installed." How's that read? Any link on further details?
There was a problem hiding this comment.
Not quite yet a link but that being said here is a good example of why:
This is the mongo plugin if you are wondering.
There was a problem hiding this comment.
This stance will likely change at some point in the future as sensu will no longer NEED a ruby runtime so it's packaging may no longer be the defacto standard. Once this happens it opens up a lot of requests regarding reducing footprint for special use cases such as embedded devices and containers.
There was a problem hiding this comment.
@majormoses I'm with you. It's a great call to mention is and I'm happy linking to Mongo as an example. Doesn't have to be canonical, just something.
|
☝️ I think that'll address your request. Thanks for the feedback as always 🤗 |
Fixes #1
General