logstash-plugins / logstash-integration-snmp

Logstash Integration Plugin for SNMP, including SNMP input and SNMP Trap Plugins
Apache License 2.0
0 stars 3 forks source link

Doc: Migration from standalone to integration plugin #15

Closed karenzone closed 4 months ago

karenzone commented 4 months ago

Starts with @edmocosta's great work in #14 and expands it.

Design intent

@edmocosta, thanks for your great work on this. Let's discuss this approach and decide on next steps.

Fixes: #11

karenzone commented 4 months ago

@edmocosta this work adds quite a few links and dependencies. I'm wondering if it makes sense to generate docs, and then to follow on immediately with the migration guides. Let's discuss! :-)

karenzone commented 4 months ago

You can see a mocked up version of the snmp docs here:

karenzone commented 4 months ago

@edmocosta, thank you for your comments. I added your suggestion and committed another fix that got my mocked up files building. 🎉

As mentioned earlier, my test files are mocked up "because the integration plugin isn't generating doc files yet. This hack makes it easy to obscure problems with formats and links, so hang on!" We should be able to quickly resolve any glitches that come up when we merge and publish.

All that said... This content is ready to go. I believe you'd mentioned absorbing the contents of this PR into your branch? Or I can merge this one. However you want to proceed works for me. Please continue to keep me in the loop.

edmocosta commented 4 months ago

@edmocosta, thank you for your comments. I added your suggestion and committed another fix that got my mocked up files building. 🎉

As mentioned earlier, my test files are mocked up "because the integration plugin isn't generating doc files yet. This hack makes it easy to obscure problems with formats and links, so hang on!" We should be able to quickly resolve any glitches that come up when we merge and publish.

All that said... This content is ready to go. I believe you'd mentioned absorbing the contents of this PR into your branch? Or I can merge this one. However you want to proceed works for me. Please continue to keep me in the loop.

Thank you again @karenzone! could you please merge it? I'll update my branch later, no worries! :)