CRD doc generation leads to bad formatting

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
42/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
kubernetes
Área
documentation

Línea de trabajo

Comience con la sección renderizada del CRD de NiFi en la URL enlazada de crds.stackable.tech e identifique cómo se genera la documentación de Quantity. Siga esa entrada a través del flujo de generación de documentación y, después, verifique que los campos Quantity afectados se rendericen sin el formato incorrecto en la documentación CRD generada.

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

Descripción

E.g. In the NiFi CRD docs here https://crds.stackable.tech/24.11.0/nifi.stackable.tech/nificluster/v1alpha1/#spec-nodes-config-resources-storage-stateRepo-capacity (probably is everywhere where Quantity is used).

Image

Possible fixes:

  • We can try to remove that doc comment from rendering
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

  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 stackabletech/documentation

Todos los issues de stackabletech/documentation

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.