elastic / elastic/integrations
Add documentation links to advanced option descriptions
- Dominant language
- Handlebars
- Stars
- 333
- Forks
- 647
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 182
Description
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):
Example of Custom TCP Options with a documentation link (PANW):
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:
- Custom TCP Options (Usually found on TCP inputs)
- Custom UDP Options (Usually found on UDP inputs)
- SSL Options (Usually found on TCP inputs, but may be used elsewhere)
Contributor guide
Assessment
This issue has not been assessed yet.