Quality issues in plugin docs (continued from #6693)
Reference: Support Matrix
Global:
[ ] Style of the description varies from plugin to plugin. Would be nice to make the descriptions for consistent in style (at least for the plugins that we maintain).
[ ] some of the example formatting is messed up with the example being broken into a mixture of example and text.**
Codec Plugins:
[ ] In plugins-codecs-cef, the example under the delimiter option needs to be formatted correctly
[ ] plugins-codecs-dots doesn't really contain any doc content. Needs an example at least.
[ ] plugins-codecs-edn doesn't really contain any doc content. Added description, but still needs an example.
[ ] plugins-codecs-edn_lines doesn't really contain any doc content. Added description, but still needs an example
[ ] plugins-codecs-msgpack doesn't really contain any doc content. Added description, but still needs an example.
[ ] In plugins-codecs-nmap, the list of event types should be formatted as a list.
[ ] In plugins-codecs-protobuf, link is formatted incorrectly and bullet list under the include_path option needs formatting.
Integrations:
[ ] AWS docs fixes
Meta:
[ ] In filters-elapsed, correct default coding for periodic_flush. See discussion in #36. NOTE: From CS: "I just looked at elastic/logstash#6693 and note that this also impacts the metrics, aggregate, multilines and throttle filters (per my quick search ^^)"
Quality issues in plugin docs (continued from #6693) Reference: Support Matrix
Global:
Input plugins:
ssl
missing from options tablefilter
option needs returns to render correct. Correct typos.validate_after_inactivity
option contains weird formatting and # sign.Output Plugins:
doc
to_doc
acks
could be better.Filter Plugins:
periodic_flush
. See discussion in #36periodic_flush
. See discussion in #36Codec Plugins:
delimiter
option needs to be formatted correctlyinclude_path
option needs formatting.Integrations:
Meta:
periodic_flush
. See discussion in #36. NOTE: From CS: "I just looked at elastic/logstash#6693 and note that this also impacts the metrics, aggregate, multilines and throttle filters (per my quick search ^^)"