elastic / elastic/logstash

Be explicit on JRuby being a requirement to create a custom plugin

Open
#6,555 1 comment 0 reactions 0 assignees View on GitHub
developer docs
Dominant language
Java
Stars
14.9k
Forks
3.5k
Avg merge
1d 4h
Merged PRs (30d)
88

Description

Looking at the documentation pages for creating plugins, the only mention about JRuby being a requirement is in the [contributing a patch](https://www.elastic.co/guide/en/logstash/current/contributing-patch-plugin.html#_putting_it_all_together) page.

Pages like [How to write a logstash input plugin](https://www.elastic.co/guide/en/logstash/current/_how_to_write_a_logstash_input_plugin.html) should also inform of this dependency.

Contributor guide

Open the contributing guide

Research direction

Start with the “How to write a logstash input plugin” documentation page and compare it with the linked “contributing a patch” page, where the JRuby requirement is already mentioned. Update the plugin-creation documentation pages to state that JRuby is required, then verify that the relevant plugin guides clearly communicate this dependency.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.