Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation discrepancy - Custom Kibana settings on Elastic Cloud #193431

Open
emrcbrn opened this issue Sep 19, 2024 · 4 comments
Open

Documentation discrepancy - Custom Kibana settings on Elastic Cloud #193431

emrcbrn opened this issue Sep 19, 2024 · 4 comments
Assignees
Labels
docs enhancement New value added to drive a business result Team:Docs

Comments

@emrcbrn
Copy link
Contributor

emrcbrn commented Sep 19, 2024

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.

@emrcbrn emrcbrn added docs enhancement New value added to drive a business result Team:Docs labels Sep 19, 2024
@elasticmachine
Copy link
Contributor

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

@florent-leborgne
Copy link
Contributor

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
Copy link
Contributor Author

emrcbrn commented Sep 19, 2024

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
Copy link
Contributor

florent-leborgne commented Sep 19, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New value added to drive a business result Team:Docs
Projects
None yet
Development

No branches or pull requests

4 participants