elastic / kibana

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

Documentation discrepancy - Custom Kibana settings on Elastic Cloud #193431

Open emrcbrn opened 7 hours ago

emrcbrn commented 7 hours ago

Description

Currently, when a user checks the Elastic Cloud documentation to check which Kibana settings can be modified, they do not align with the Kibana settings we list in the main Kibana documentation, or specifically, there is no icon that confirms it's supported:

Image

For the setting server.maxPayload this is the case, but there might be a need to review other Kibana settings and cross-check what's officially supported on Elastic Cloud and add the icon where needed.

What should be reviewed/corrected

Review Kibana settings and cross-check what's officially supported on Elastic Cloud and add the icon where needed.

elasticmachine commented 7 hours ago

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

florent-leborgne commented 7 hours ago

Hi @emrcbrn, thanks for raising this. Is there one of the 2 docs that is correct, and is there a way to check which ones are supported?

emrcbrn commented 7 hours ago

Hi @florent-leborgne ! I think the main source of truth is the Elastic Cloud supported documentation, so we should use that to correct the Kibana docs.

is there a way to check which ones are supported?

Yes, test every setting documented in our Cloud documentation for custom settings in an Elastic Cloud environment to be sure it's 100% correct, then correct the main Kibana documentation. Though it's a bit of a tedious process, to be honest.

florent-leborgne commented 7 hours ago

I think the main source of truth is the Elastic Cloud supported documentation, so we should use that to correct the Kibana docs.

Got it. That's at least one way we can start with it. Though I'm not entirely sure what is the benefit of documenting this in 2 different places. As you pointed out, it just creates maintenance hassle and risk for discrepancies. In parallel to updating the Kibana docs, we'll investigate if there's a way to refactor these into a unique, maintained, source of truth.