Operators: Turn examples into documentation
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
- Área
- documentation
Línea de trabajo
Comienza revisando los directorios de ejemplos de operadores y la guía de inicio, donde los ejemplos han comenzado a trasladarse a documentación probada. Haz un inventario de los ejemplos restantes en todos los operadores, identifica cuáles deberían convertirse en guías específicas y define la finalización de modo que cada ejemplo seleccionado esté documentado y probado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
We have the example directories in the operators, which are very useful for us devs to quicky deploy an instance of something. But the examples are not tested.
With the getting started guide we started moving examples into the docs and testing them. It would make sense to keep doing this, with the other examples as well. There are specific examples which deploy an instance + OPA etc., which we could turn into specific docs guides.
This would be an epic and needs to be done for all operators.
- Lenguaje dominante
- CSS
- Estrellas
- 13
- Forks
- 14
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 10
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de stackabletech/documentation
-
Withdraw ADR018 Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
stackabletech/documentation#734 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
stackabletech/documentation#779 ·
-
customer-request
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
stackabletech/documentation#773 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
stackabletech/documentation#754 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
stackabletech/documentation#753 ·
Todos los issues de stackabletech/documentation
Issues similares
-
triage
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
feature pydanty:is-working
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
pydantic/pydantic-ai#8647 ·
-
Add date o "release information" Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Add more to the documentation Abierto:watch: Not Triaged dotnet-fsharp/svc
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100