Skip to content

[docs] List assets included/associated with each integration's README #3625

@colleenmcginnis

Description

@colleenmcginnis

In #3433, @jamiehynds suggested that we consider listing assets included/associated with each integration:

We could consider a section to cover assets included, or associated with the integration. e.g. describe the dashboards and saved searches that ship with the integration. Possibly even link to detection rules/ML jobs/alerts that may be associated with the integration (but doesn't ship with the integration)

However, after looking at the dashboards for the top 5 integrations I was updated in https://github.com/elastic/observability-docs/issues/1019, I think we should consider automating this instead of maintaining freeform narrative text about specific dashboards.

As a first step, a writer could help with dashboard descriptions in the JSON files found in packages/*/kibana/dashboard/. Then we could generate a list of them from the JSON.

@jamiehynds also suggested adopting a similar approach for detection rules.

cc @approksiu @jamiehynds @elastic/obs-docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    StalledTeam:DocsLabel for the Observability docs teamdocumentationImprovements or additions to documentation. Applied to PRs that modify *.md files.enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions