search

elastic / integrations

Elastic Integrations
https://www.elastic.co/integrations
Other
194 stars 421 forks source link

Better documentation for code-only configurations #3412

Open xeraa opened 2 years ago

xeraa commented 2 years ago

We need to improve our documentation for the code-only configuration of integrations if we want them to be successful in (dev)ops environments. A recent Twitter discussion and multiple conversations at KubeCon Europe have shown: If it cannot be easily configured as code, it doesn't exist.

Taking the Twitter conversation as an example: I couldn't find good (or really any) documentation on how to configure our 1Password integration in standalone mode (so code-only). https://github.com/elastic/integrations/blob/main/packages/1password/manifest.yml#L32-L70 is kind of showing me what I need, but it feels more like reverse-engineering than the way we should be providing to our users.

elasticmachine commented 2 years ago

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

ruflin commented 2 years ago

@jlind23 @ph I marked this with the control plane label as I think this goes way beyond 1 password and is a more generic problem around inputs, docs and what we recommend etc.

botelastic[bot] commented 1 year 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!

xeraa commented 1 year ago

This is still a frequent discussion point

botelastic[bot] commented 3 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!

xeraa commented 3 months ago

Maybe as a reference point: I ran roundtable discussions at ElasticON Frankfurt, Amsterdam, and NY — the lack of documentation for standalone came up in every single one...