search

elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.65k stars 8.23k forks source link

[DOCS] Enhance Swimlane connector field mappings configuration #144964

Open cnasikas opened 2 years ago

cnasikas commented 2 years ago

To configure a Swimlane connector the user needs to configure a) the connection b) the field mappings. Instructions regarding the field mapping configuration are missing. Swimlane has certain field types and Kibana expects the field types to be configured correctly. To aid the users we should add to the docs a) what is the purpose of each field and b) what field types are expected by Kibana.

Example of mapping

Screenshot 2022-11-10 at 10 55 57 AM Screenshot 2022-11-09 at 1 46 13 PM
elasticmachine commented 2 years ago

Pinging @elastic/kibana-docs (Team:Docs)

lcawl commented 2 years ago

We're generally trying to move away from having a lot of reference information in https://www.elastic.co/guide/en/kibana/master/swimlane-action-type.html and instead put that detail in (1) the API docs and (2) user assistance text directly in the UI.

I therefore think we should tackle this issue by taking the descriptions that exist in the API docs for these fields as a starting point for improving the UI text.