elastic / elastic/stack-docs

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

オープン
#139 コメント 3 件 リアクション 1 件 担当者 0 名 GitHub で見る
discussion meta
主要言語
Java
スター
105
フォーク
249
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

既存の cloud、Elasticsearch、Kibana の設定パラメーターに関するドキュメントと、リンクされている提案を確認することから始めます。各パラメーターが on-premises、ECE、または Elasticsearch Service のどれをサポートしているかを示せる、一貫した方法を定義します。これらのドキュメントのエントリーポイントのいずれかからパラメーターにたどり着いた顧客が、サポートされているデプロイメントタイプを識別できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
elasticsearch
領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。