elastic / elastic/integrations

[Release Notes / Enhancements / Docs] Integrations should provide a pointer to the release notes of the components used

Open
#11,574 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement Stalled
Dominant language
Handlebars
Stars
333
Forks
647
Avg merge
3d 4h
Merged PRs (30d)
209

Description

In the current state, the release notes of integrations only report the changes to the integrations.
It would be useful to surface a pointer to the release notes of the component(s) used by the integration.
Something like "This integration relies on Filebeat X input and Metricbeat Y module".

In short, it would be good to surface what we have for standalone (https://www.elastic.co/guide/en/fleet/current/elastic-agent-inputs-list.html) inputs, but publish it in the integrations docs / fleet ui and make it automatically generated.

It can be useful in case users might have issues or spot a bug and they might check the release notes of the underlying component to know if there are fixes associated to it

Examples:
- Custom Logs -> Filebeat release notes (logfile input)
- Crowdstrike FDR -> Filebeat release notes (logfile or aws s3 or cel input - depending on the data stream)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.