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

Standardize our configuration parameter docs to indicate ECE/Elasticsearch Service vs. on-prem support #139

Open
nrichers opened this issue Nov 1, 2018 · 3 comments

Comments

@nrichers
Copy link
Contributor

nrichers commented Nov 1, 2018

From @jakommo:

I’ve seen many issues where ECE customers tried to apply on-prem configs, because this was the first search result that came up on google. I was wondering if it would make sense to have both (ECE and on-prem) instructions on the same page, or at least add a note to on-prem docs with a link to the ECE config for this feature.

We probably don't want to merge these docs as they are today, but we should track the issue of how we can improve the documentation of configuration parameters to indicate what they apply to, regardless of your entry point into the docs.

Among the issues that end up confusing customers today:

  • We whitelist parameters for Elasticsearch Service and blacklist parameters for ECE. These are documented only in our cloud docs, but not, say, in our ES or Kibana docs. If you start in our cloud docs, you'll be mostly fine, although we don't document the blacklisted parameters exhaustively today. These docs to link to the ES or Kibana docs.
  • People googling for content can easily end up on the ES or Kibana docs looking at a configuration parameter, with no indication that the parameter is not supported for our cloud products. They try it and

One proposal might be to standardize how we document configuration parameters and add a field that indicates whether or not the parameter is supported on-prem, in ECE, or on the Elasticsearch Service.

Source: https://docs.google.com/document/d/1iUZGa1K-wM5Fu4_Ho3Wep5MQyG-d47XJWve2oGcRyak/edit#bookmark=id.2f62wskyv2rk

@inqueue
Copy link
Member

inqueue commented Aug 21, 2019

Has there been any movement on this topic? The issues expressed here continue to be a source of user confusion.

@jakommo
Copy link

jakommo commented Aug 21, 2019

One proposal might be to standardize how we document configuration parameters and add a field that indicates whether or not the parameter is supported on-prem, in ECE, or on the Elasticsearch Service.

I like that idea. It would already help if all the blacklisted (or not whitelisted ?) params had a little note indicating that it's blacklisted and maybe link to a page that explains why.
But for the start, a little note that this blacklisted in ESS/ECE/ECK? would be nice.

@muralivenkataraman
Copy link

muralivenkataraman commented Aug 21, 2019

I am removing my comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants