stackabletech / stackabletech/documentation

Operator env vars documentation

Abierto
#515 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
CSS
Estrellas
13
Forks
14
Merge medio
4 d 8 h
PR fusionados (30 d)
10

Descripción

currently there is hand written docs for env vars and commandline parameters, but that in itself isn't useful.

The users want to set this with Helm, or somehow in OpenShift (or maybe with stackablectl?)

These things should go into the Reference section.

We should also think about maybe generating this if we can (but not necessary, as there are probably not that many settings). Maybe we can have instead common operator flags as a partial somewhere, that we can simply reference in all the operators.

related: https://github.com/stackabletech/documentation/issues/514

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

Comienza localizando la documentación existente, escrita manualmente, sobre variables de entorno y parámetros de la línea de comandos; después, revisa las secciones Reference y el issue relacionado 514. Se considera terminado cuando la configuración está documentada de una forma que los usuarios puedan aplicar con Helm u OpenShift, y cualquier decisión sobre partials compartidos o generación queda registrada en la documentación resultante.

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

Evaluación

Stack tecnológico
helm
Área
documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.