elastic / package-spec

EPR package specifications
Other
17 stars 70 forks source link

Document available handlebars helpers in `agent/spec.yml` file #387

Open kpollich opened 2 years ago

kpollich commented 2 years ago

As called out in https://github.com/elastic/kibana/pull/135992#issuecomment-1181825725, we should include documentation for any available templating helpers in the agent/spec.yml file for each package type.

The available helpers today are

See https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/server/services/epm/agent/agent.ts for the code where Fleet registers these helpers in its templating engine.

These spec docs should include a written description of each helper (see above) as well as example usage.

ruflin commented 2 years ago

++ on adding these docs. Lets make sure we find a way that these docs are easy accessible to every engineer building integrations without having to read docs inside a yaml file. Of course, the spec file should be source of truth.