elastic / integrations

Elastic Integrations
https://www.elastic.co/integrations
Other
25 stars 437 forks source link

Add documentation links to advanced option descriptions #4739

Open taylor-swanson opened 1 year ago

taylor-swanson commented 1 year ago

Many of our integrations include configuration options to provide advanced settings for TCP, UDP inputs, SSL, etc. These are free-form fields and the user will need to know ahead of time what to provide. We should provide a link to the corresponding documentation that describes what fields may be provided. A few of our integrations already do this (PANW, for example), but many others are missing this documentation (Fortigate, for example).

Example of Custom TCP Options lacking a documentation link (Fortigate): Screen Shot 2022-11-30 at 8 12 05 AM

Example of Custom TCP Options with a documentation link (PANW): Screen Shot 2022-11-30 at 8 27 56 AM

This issue should apply to all integrations that allow providing custom options for inputs or other configuration areas. This includes, but is not limited to:

elasticmachine commented 1 year ago

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

botelastic[bot] commented 11 months ago

Hi! We just realized that we haven't looked into this issue in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!