[system] [elastic_agent] Add existing README as KB doc for system + elastic_agent integrations

[kpollich]

Proposed commit message

Make existing README available as a knowledge base document for Elastic AI assistants.

Checklist

• I have reviewed tips for building integrations and this pull request is aligned with them.
• I have verified that all data streams collect metrics or logs.
• I have added an entry to my package's changelog.yml file.
• I have verified that Kibana version constraints are current according to guidelines.
• I have verified that any added dashboard complies with Kibana's Dashboard good practices

[elasticmachine]

Pinging @elastic/sec-linux-platform (Team:Security-Linux Platform)

[elasticmachine]

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

[elasticmachine]

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

[elastic-vault-github-plugin-prod]

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 8230df4

cc @kpollich

[jen-huang]

I did something similar for testing, but coping the exact READMEs does place additional burden on package authors to remember to look for and update them in two places. Not sure how folks feel about that...

It would be interesting if Fleet treated the base READMEs as additional KB content that is automatically indexed, I remember we discussed this during design of KB content but don't remember if we deferred or decided to not do that.

[ishleenk17]

I did something similar for testing, but coping the exact READMEs does place additional burden on package authors to remember to look for and update them in two places. Not sure how folks feel about that...

It would be interesting if Fleet treated the base READMEs as additional KB content that is automatically indexed, I remember we discussed this during design of KB content but don't remember if we deferred or decided to not do that.

I tend to agree with @jen-huang on this @kpollich, since the KB README's are manually duplicated and not generated as part of the build.
Could you please share what is the motive for this change and why can't the current README'e be referred to ?

[jen-huang]

I tend to agree with @jen-huang on this @kpollich, since the KB README's are manually duplicated and not generated as part of the build.

Could you please share what is the motive for this change and why can't the current README'e be referred to ?

Fleet currently looks specifically in this /docs/knowledge directory for content to index for consumption by AI assistants. It will be additional work (but not a ton) to also index the base README.

But actually I like the idea of automatically duplicating the base README to that directory during the package build process. That would require no additional Fleet changes or work for package developers. We would just have to come to the consensus that all base READMEs are useful for the AI assistants to consume.

[nimarezainia]

@jen-huang I think at this point in time all the READMEs should be copied into the knowledge directory to give us an immediate content for AI to noodle on. We can always refine/remove that if better content becomes available.

[ishleenk17]

@jen-huang I think at this point in time all the READMEs should be copied into the knowledge directory to give us an immediate content for AI to noodle on. We can always refine/remove that if better content becomes available.

@nimarezainia : I understand we're planning to roll this out across all Integrations.

Given that Jen mentioned here that it's relatively straightforward, could we incorporate this README generation into the elastic-package build process? Since we update Integrations and their READMEs frequently, manually maintaining these could quickly become outdated without automated generation."