Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#139 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
elasticsearch
Área
documentation

Línea de trabajo

Empieza revisando la documentación existente sobre los parámetros de configuración de cloud, Elasticsearch y Kibana, así como la propuesta vinculada. Define una forma coherente para que cada parámetro indique si admite on-premises, ECE o Elasticsearch Service. Se considerará terminado cuando los clientes que lleguen a un parámetro desde cualquiera de estos puntos de entrada de la documentación puedan identificar los tipos de implementación compatibles.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

discussion meta

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

Lenguaje dominante
Java
Estrellas
105
Forks
249
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de elastic/stack-docs

Todos los issues de elastic/stack-docs

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.